-
Notifications
You must be signed in to change notification settings - Fork 563
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
base: release/v1.1.0
Are you sure you want to change the base?
Conversation
WalkthroughThe 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
Possibly related PRs
Suggested labels
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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 clarityA few suggestions to enhance readability and maintain brand consistency:
- Remove "(NEW)" from the title as it's temporary and will become outdated
- Consider replacing "subsumed" with "replaced" for clarity
- 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 documentationThe environment variables section needs consistent formatting:
- Use inline code formatting for environment variables
- Add missing punctuation
- 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 errorThere'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
⛔ 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.
.. image:: /images/teams/qp_toggle.png | ||
:alt: query-performance-toggle | ||
:align: center |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
.. 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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
For more information on summary fields, see :ref:`_summary-fields`. | |
For more information on summary fields, see :ref:`summary-fields`. |
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.
Release Notes
Is this a user-facing change that should be mentioned in the release notes?
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?
fiftyone
Python library changesSummary by CodeRabbit
New Features
Documentation