coderabbitai[bot]
commented
1 week ago Walkthrough
The pull request introduces significant updates to the developing_plugins.rst documentation for FiftyOne. It adds new sections on "Execution Store," "Saved Workspaces," "Accessing Secrets," and "Common Patterns," providing detailed guidance for plugin development. The document's structure has been refined for clarity, and examples have been updated to reflect best practices for creating Python and JavaScript plugins. Additionally, the ExecutionStoreRepo class and related methods have been modified to enhance data retrieval and management, while the Executor class has been updated to streamline access to execution stores.
Changes
| File | Change Summary |
|---|---|
| docs/source/plugins/developing_plugins.rst | Added sections on "Execution Store," "Saved Workspaces," "Accessing Secrets," and "Common Patterns"; refined document structure and updated examples for clarity and best practices. |
| fiftyone/factory/repos/execution_store.py | Refactored list_stores and count_stores methods to use aggregation pipelines; modified has_store_global, list_stores_global, and count_stores_global methods for improved data handling. |
| fiftyone/operators/init.py | Added import for ExecutionStore from .store. |
| fiftyone/operators/executor.py | Updated store method to retrieve existing execution store with automatic creation; moved ExecutionStore import to the top. |
| fiftyone/operators/store/service.py | Updated create_store method to explicitly include metadata parameter in the method call. |
| fiftyone/operators/store/store.py | Removed get_ttl method and added get_metadata method to return metadata about keys. |
| tests/unittests/execution_store_unit_tests.py | Removed test_list_stores method from integration tests. |
Possibly related PRs
- #4827: This PR introduces the
ExecutionStorecomponent, which is directly related to the new section on "Execution Store" added in the main PR's documentation. - #4877: This PR modifies the
ExecutionStoreRepoclass, relevant to the main PR as it discusses the management of execution stores. - #4954: This PR introduces changes to the
Executorclass regarding the management of execution stores, tying into the main PR's focus. - #5062: This PR adds functionality for cleaning up execution stores, relating to the main PR's updates on managing execution stores.
- #5086: This PR enhances the
ExecutionStoreRepointerface, relevant to the main PR's documentation updates. - #5095: This PR focuses on integration tests for the
ExecutionStore, directly related to the main PR's updates.
Suggested labels
feature, cleaning
Suggested reviewers
- lanzhenw
Poem
In the garden of code, where plugins bloom,
New sections sprout, dispelling the gloom.
With stores for execution, secrets to keep,
Our documentation grows, a treasure to reap.
So hop to it, dear devs, let your plugins take flight,
In FiftyOne's world, everything feels right! 🐇✨
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?
Documentation for the ExecutionStore
Summary by CodeRabbit