Release notes v0.25.0 #4647
Release notes v0.25.0 #4647
Conversation
WalkthroughThe recent changes significantly enhance the FiftyOne platform by improving both documentation and functionality. Key updates include a structured deprecation section for better navigation, a refined user management and permissions system, performance optimizations, and enhancements to the management SDK. Overall, these changes boost user experience, security, and operational efficiency while ensuring clarity and consistency in documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App
participant Cloud
User->>App: Request to manage credentials
App->>Cloud: Validate user permissions
Cloud-->>App: Respond with permission status
App-->>User: Allow or deny access
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (6)
docs/source/release-notes.rst (6)
6-22: Ensure clarity and completeness in the "What's New" section.The descriptions of new features and improvements are generally clear. However, consider providing more context or examples for the new permission system and the changes to plugin execution to help users understand the impact of these changes.
23-32: Clarify the "App" section improvements.The improvements to the caching layer, dataset cloning, and user management are well-described. Ensure that the bug fixes related to user roles and recent views are clearly explained, including any user-facing impacts these fixes address.
34-41: Expand on the "CAS" section updates.The addition of the Audit page and changes to group management are significant. Consider providing more details on how these features benefit super admins and any potential configuration steps required.
43-53: Clarify the "SDK" section enhancements.The introduction of the
user_groupsmodule and improvements to cloud credential management are important. Ensure that users understand how to leverage these new capabilities, possibly with links to relevant documentation or examples.
57-135: Ensure completeness in the "FiftyOne 0.25.0" section.The section provides a comprehensive overview of new features and bug fixes. Verify that all significant changes are included and that the descriptions are clear and concise. Consider adding any missing context for complex features like Elasticsearch integration and Python panels.
137-169: Enhance clarity in the "Plugins" and "Zoo" sections.The updates to plugins and the model zoo are well-documented. Ensure that users understand the implications of these changes, particularly the new models and GPU inference support. Consider adding links to detailed documentation or examples where applicable.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/deprecation.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- docs/source/teams/management_sdk.rst (3 hunks)
Files skipped from review due to trivial changes (2)
- docs/source/deprecation.rst
- docs/source/teams/management_sdk.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (8)
docs/source/release-notes.rst (8)
6-22: Ensure clarity and consistency in the new features description.The descriptions of new features and improvements are generally clear. However, consider adding more context or examples for complex features like "user-aware plugin execution" to help users understand the implications better.
23-32: Clarify the impact of bug fixes.The bug fixes are mentioned, but consider providing more details on how these fixes improve user experience or address specific issues users might have encountered.
34-41: Enhance the description of new Super Admin UI features.The new features for the Super Admin UI are briefly described. Consider expanding on the benefits of these features, such as how the Audit page helps monitor license utilization.
43-53: Provide more details on SDK improvements.The introduction of the
user_groupsmodule and updates to existing functions are significant. Consider providing examples or use cases to illustrate how these changes can be utilized by developers.
57-76: Clarify new feature descriptions.The new features, such as Python panels and Elasticsearch integration, are exciting additions. Consider expanding on their potential applications or benefits to users.
77-104: Enhance clarity of App feature descriptions.The new features and bug fixes are well listed. Consider providing more details on how these changes improve usability or address specific user needs.
106-136: Provide more context for Annotation and Core improvements.The improvements in annotation support and core functionalities are beneficial. Consider elaborating on how these changes enhance user workflows or system performance.
137-169: Expand on Plugins and Zoo updates.The updates to plugins and model support are valuable. Consider adding examples or scenarios where these new capabilities can be effectively used.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/deprecation.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- docs/source/teams/management_sdk.rst (3 hunks)
Files skipped from review due to trivial changes (1)
- docs/source/teams/management_sdk.rst
Files skipped from review as they are similar to previous changes (1)
- docs/source/deprecation.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- docs/source/release-notes.rst (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/source/release-notes.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- docs/source/release-notes.rst (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/source/release-notes.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/deprecation.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- docs/source/teams/management_sdk.rst (3 hunks)
Files skipped from review due to trivial changes (1)
- docs/source/deprecation.rst
Files skipped from review as they are similar to previous changes (2)
- docs/source/release-notes.rst
- docs/source/teams/management_sdk.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (10)
docs/source/release-notes.rst (10)
14-15: Clarify the "Can tag" permission description.The description of the "Can tag" permission could be expanded to clarify what tagging entails and how it differs from other editing capabilities. Consider providing examples or a brief explanation to enhance user understanding.
16-19: Ensure clarity in GCP credential support description.The description of the GCP credential support could benefit from additional details about how authorized user credentials and external account credentials are configured. This would help users understand the implementation better.
25-27: Clarify dataset cloning enhancements.The description of the dataset cloning feature could specify what "runs" refers to, as this might not be immediately clear to all users. Consider adding a brief explanation or example.
36-39: Expand on the Audit page functionality.The description of the new Audit page could include more details about what information is displayed and how it can be used by super admins. This would help users understand the benefits of this feature.
45-46: Clarify the purpose of the user_groups module.The description of the user_groups module could include examples or scenarios where programmatically managing user groups would be beneficial. This would provide users with a clearer understanding of its use cases.
48-49: Ensure clarity in upload_media function upgrade.The description of the upload_media function upgrade could specify what "gracefully support fields with missing media paths" means in practice. Providing examples or additional context would be helpful.
63-66: Expand on Python panels framework.The description of the Python panels framework could include examples of builtin components and potential use cases to help users understand its capabilities and benefits.
79-82: Clarify linking directly to a sample or group.The description of linking directly to a sample or group could include examples of how this feature can be used programmatically, providing more context for users.
118-119: Clarify save contexts support.The description of save contexts support could include examples or scenarios where this feature would be particularly useful, helping users understand its practical applications.
168-169: Clarify YOLOv10 and RT-DETR models addition.The description of the new YOLOv10 and RT-DETR models could include details about their capabilities or improvements over previous versions, providing users with more context.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (7)
docs/source/release-notes.rst (7)
14-15: Clarify permission description.The description for the "Can tag" permission could be more explicit about what "tagging" entails and how it differs from "editing."
Consider providing examples or more context to clarify this distinction.
25-29: Enhance clarity on dataset cloning improvements.The mention of "saved views, saved workspaces, and runs" could benefit from a brief explanation of what these terms mean in the context of dataset cloning.
Consider adding a short description or a link to relevant documentation.
36-39: Clarify group management feature.The description of disabling manual group management could be expanded to explain the implications and benefits of this feature.
Consider providing examples of scenarios where this would be useful.
45-47: Clarify user_groups module functionality.The new user_groups module should include a brief overview of its capabilities and potential use cases.
Consider adding a short description or a link to relevant documentation.
63-66: Clarify Python panels framework.The description of Python panels could benefit from examples or a link to more detailed documentation to help users understand its capabilities.
Consider adding a short description or a link to relevant documentation.
111-114: Clarify annotation support for views.The description of annotation support for frame and clip views could include examples or use cases to illustrate its benefits.
Consider adding a short description or a link to relevant documentation.
121-123: Clarify save contexts feature.The description of save contexts could include examples or a link to more detailed documentation to help users understand its capabilities.
Consider adding a short description or a link to relevant documentation.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- docs/source/release-notes.rst (1 hunks)
Additional comments not posted (4)
docs/source/release-notes.rst (4)
16-19: Ensure GCP credentials integration details are comprehensive.The integration of user credentials for GCP configurations should specify any prerequisites or steps needed for setup.
Ensure that users have access to detailed setup instructions elsewhere in the documentation.
48-53: Ensure clarity on add_cloud_credentials changes.The addition of the overwrite parameter should be clearly explained, including its default behavior and potential impact on existing credentials.
Ensure that users have access to detailed usage instructions elsewhere in the documentation.
74-75: Ensure Elasticsearch integration details are comprehensive.The Elasticsearch integration should specify any prerequisites or configuration steps needed.
Ensure that users have access to detailed setup instructions elsewhere in the documentation.
126-128: Ensure index statistics feature is clear.The addition of index statistics in Dataset.stats() should be explained, including what statistics are available and how they can be used.
Ensure that users have access to detailed usage instructions elsewhere in the documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/deprecation.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- docs/source/teams/management_sdk.rst (3 hunks)
Files skipped from review due to trivial changes (1)
- docs/source/deprecation.rst
Files skipped from review as they are similar to previous changes (2)
- docs/source/release-notes.rst
- docs/source/teams/management_sdk.rst
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/plugins/developing_plugins.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- fiftyone/operators/init.py (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/source/plugins/developing_plugins.rst
Files skipped from review as they are similar to previous changes (1)
- docs/source/release-notes.rst
Additional context used
Ruff
fiftyone/operators/__init__.py
17-17:
.executor.ExecutionContextimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
fiftyone/operators/__init__.py
Outdated
| @@ -14,6 +14,7 @@ | |||
| ) | |||
| from .executor import ( | |||
| execute_operator, | |||
| ExecutionContext, | |||
There was a problem hiding this comment.
Address the unused import of ExecutionContext.
The ExecutionContext is imported but not used within the file. Consider removing it, adding it to __all__, or using it to avoid unnecessary imports and maintain clean code.
- ExecutionContext,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.
| ExecutionContext, |
Tools
Ruff
17-17:
.executor.ExecutionContextimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- docs/source/deprecation.rst (1 hunks)
- docs/source/release-notes.rst (1 hunks)
- docs/source/teams/management_sdk.rst (3 hunks)
Files skipped from review as they are similar to previous changes (3)
- docs/source/deprecation.rst
- docs/source/release-notes.rst
- docs/source/teams/management_sdk.rst
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (1)
docs/source/images/plugins/panels/dashboard-panel.gifis excluded by!**/*.gif,!**/*.gif
Files selected for processing (2)
- docs/source/plugins/developing_plugins.rst (12 hunks)
- docs/source/plugins/index.rst (2 hunks)
Additional comments not posted (8)
docs/source/plugins/index.rst (2)
44-45: Addition of@voxel51/dashboardplugin is well-formatted.The new plugin entry is consistent with existing entries, including a link and a description.
85-90: Example usage of@voxel51/dashboardplugin is clear and informative.The example enhances the documentation by providing a visual illustration of the plugin's functionality.
docs/source/plugins/developing_plugins.rst (6)
Line range hint
2474-2495: Renaming toDropdownMenuExampleand enhancement insay_himethod are effective.The renaming aligns with the new naming convention, and the
variantargument insay_hienhances feedback.
Line range hint
2597-2637: Renaming toInteractivePlotExampleand update inon_loadmethod are beneficial.The renaming improves clarity, and the use of
_make_matching_viewsuggests an enhancement in view creation logic.
Line range hint
2709-2750: Renaming toWalkthroughExampleis consistent and clear.The renaming aligns with the new naming convention, enhancing clarity.
2853-2858: Renaming toImageExampleis clear and consistent.The renaming aligns with the new naming convention, clarifying the class's purpose.
2915-2920: Renaming toMediaPlayerExampleis clear and consistent.The renaming aligns with the new naming convention, enhancing clarity.
Line range hint
2682-2689: Renaming to_make_matching_viewenhances clarity.The renaming provides a more descriptive name, improving clarity about the function's purpose.
Summary by CodeRabbit
New Features
@voxel51/dashboardplugin, enhancing user guidance on custom dashboards.Bug Fixes
Documentation