Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] [Query Performance] #5136

Open
wants to merge 1 commit into
base: release/v1.1.0
Choose a base branch
from
Open

[docs] [Query Performance] #5136

wants to merge 1 commit into from

Conversation

minhtuev
Copy link
Contributor

@minhtuev minhtuev commented Nov 18, 2024

What changes are proposed in this pull request?

Added documentation for Query Performance panel

How is this patch tested? If it is not, please explain why.

  • Local testing

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features

    • Introduced a "Query Performance" section in the FiftyOne Teams documentation to enhance query efficiency.
    • Users can enable Query Performance by default, manage settings, and receive notifications for potential optimizations.
    • Added functionality for creating indexes and summary fields to improve query execution.
  • Documentation

    • Updated the table of contents to include "Query Performance."
    • Comprehensive guidance provided for utilizing the new Query Performance features.

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

The pull request introduces a new section in the FiftyOne Teams documentation that focuses on "Query Performance." It adds a reference to this section in the table of contents and provides detailed guidance on enabling and using the Query Performance feature within the application. This includes information on the functionality of indexes, summary fields, and user notifications related to query performance.

Changes

File Path Change Summary
docs/source/teams/index.rst Added new entry to the table of contents: Query Performance <query_performance>.
docs/source/teams/query_performance.rst Introduced a new section on "Query Performance" with subsections on enabling the feature, toast notifications, and managing indexes and summary fields.

Possibly related PRs

Suggested labels

documentation

🐰 In the garden of code, we hop with glee,
New features sprout, as bright as can be.
Query Performance now takes its place,
Helping users navigate with grace.
With toasts and indexes, all set to go,
In FiftyOne Teams, watch the queries flow! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (3)
docs/source/teams/query_performance.rst (3)

3-9: Improve title and introduction clarity

A few suggestions to enhance readability and maintain brand consistency:

  1. Remove "(NEW)" from the title as it's temporary and will become outdated
  2. Consider replacing "subsumed" with "replaced" for clarity
  3. Fix the product name: "Fiftyone's" should be "FiftyOne's"
-Query Performance (NEW)
+Query Performance
=======================

Query Performance is a feature built into the :ref:`FiftyOne Teams App <teams-app>`
which allows users to use FiftyOne to improve the performance of sidebar and background
-queries through the use of indexes and summary fields. Query Performance subsumed and
-expanded the capabilities of the previous Fiftyone's Lightning Mode (LM).
+queries through the use of indexes and summary fields. Query Performance replaced and
+expanded the capabilities of the previous FiftyOne's Lightning Mode (LM).

42-44: Improve environment variables documentation

The environment variables section needs consistent formatting:

  1. Use inline code formatting for environment variables
  2. Add missing punctuation
  3. Use consistent quotation marks
-Admins users can change the default setting for all users in the Teams App by setting
-`FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE` to `false`. Admin users can also completely disable
-query performance for all users by setting the `FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE` to `false`.
+Admin users can change the default setting for all users in the Teams App by setting
+``FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE`` to ``false``. Admin users can also completely disable
+query performance for all users by setting ``FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE`` to ``false``.

53-54: Fix grammatical error

There's a grammatical error in the sentence.

-example you can click on a label filter on the sidebar, and if the filter takes too longer
+example you can click on a label filter on the sidebar, and if the filter takes too long
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9a13da7 and 4bddbd3.

⛔ Files ignored due to path filters (8)
  • docs/source/images/teams/qp_config.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_create_index.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_create_summary_field.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_home.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_tableview.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_toast.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_toggle.png is excluded by !**/*.png, !**/*.png
  • docs/source/images/teams/qp_tooltip.png is excluded by !**/*.png, !**/*.png
📒 Files selected for processing (2)
  • docs/source/teams/index.rst (1 hunks)
  • docs/source/teams/query_performance.rst (1 hunks)
🔇 Additional comments (3)
docs/source/teams/index.rst (1)

147-147: LGTM! Let's verify the referenced file.

The new entry follows the documentation structure and integrates well with the existing toctree.

Let's verify that the referenced documentation file exists:

✅ Verification successful

The referenced documentation file exists at the expected location

The query_performance.rst file is present at docs/source/teams/query_performance.rst, confirming that the toctree entry is correctly linked to an existing documentation file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the query_performance.rst file exists in the correct location
# Expected: File should exist in the teams directory

fd -t f "query_performance.rst" docs/source/teams

Length of output: 89

docs/source/teams/query_performance.rst (2)

95-98: Well-structured warning messages

The warning sections effectively communicate important operational considerations about index creation and summary field operations. They provide valuable guidance for users working with large datasets.

Also applies to: 118-121


71-73: Clarify default indexes

The documentation mentions "default indexes" but doesn't specify what these are. Consider adding details about which indexes are created by default and their purpose.

Comment on lines +56 to +58
.. image:: /images/teams/qp_toggle.png
:alt: query-performance-toggle
:align: center
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incorrect image reference in toast notification section

The image reference appears to be incorrect. It's currently showing the Query Performance toggle image instead of the toast notification image.

-.. image:: /images/teams/qp_toggle.png
-    :alt: query-performance-toggle
+.. image:: /images/teams/qp_toast.png
+    :alt: query-performance-toast
     :align: center
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
.. image:: /images/teams/qp_toggle.png
:alt: query-performance-toggle
:align: center
.. image:: /images/teams/qp_toast.png
:alt: query-performance-toast
:align: center

For dataset with a large number of samples, creating, updating and deleting a summary field can take a long time to
complete.

For more information on summary fields, see :ref:`_summary-fields`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix broken cross-reference syntax

The cross-reference syntax is incorrect. Remove the underscore prefix from the reference target.

-For more information on summary fields, see :ref:`_summary-fields`.
+For more information on summary fields, see :ref:`summary-fields`.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For more information on summary fields, see :ref:`_summary-fields`.
For more information on summary fields, see :ref:`summary-fields`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant