voxel51 / fiftyone

Refine high-quality datasets and visual AI models
https://fiftyone.ai
Apache License 2.0
8.72k stars 551 forks source link

Merge `release/v0.25.0` to `develop` #4700

Closed voxel51-bot closed 1 month ago

voxel51-bot commented 1 month ago

Merge release/v0.25.0 to develop

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates to the FiftyOne documentation and codebase enhance clarity and functionality surrounding operators and panels. Key changes include consistent terminology, expanded command descriptions, and improved code examples. These modifications ensure users can effectively utilize both operators and panels within the CLI and plugin development, fostering a better understanding of the available tools and their interactions.

Changes

Files Change Summary
docs/source/cli/index.rst Updated descriptions to include "panels" alongside "operators," enhancing clarity on CLI functionalities.
docs/source/plugins/developing_plugins.rst Standardized terminology and expanded explanations, added code examples, improved formatting, and clarified state management details for plugins.
docs/source/plugins/using_plugins.rst Included "panels" in command descriptions, added new --panels-only option, and modified output tables to improve usability in plugin interactions.
fiftyone/core/cli.py Enhanced docstrings to reflect "operators and panels," improving understanding of command functionalities.
fiftyone/operators/types.py Simplified arrow_nav function by removing on_forward and on_backward parameters, streamlining the interface for ArrowNavView.
fiftyone/operators/panel.py Added "unlisted" key to the JSON output in the to_json method, enhancing the representation of the panel object state.
app/packages/app/src/components/AnalyticsConsent.tsx Updated import statements for the button component, improving code organization and clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Operators
    participant Panels

    User->>CLI: List available operators and panels
    CLI->>Operators: Fetch list of operators
    CLI->>Panels: Fetch list of panels
    Operators-->>CLI: Return operator list
    Panels-->>CLI: Return panel list
    CLI-->>User: Display operators and panels

🐇 In the meadow, I hop and play,
With panels and operators, bright as day.
Documentation's clear, updates abound,
In this joyful world, new treasures are found!
So let's celebrate, with a leap and a cheer,
For clarity blooms, and the path is now clear! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.