fiftyone.plugins.utils¶
FiftyOne plugin utilities.
Functions:
|
Returns a list of available plugins registered in the FiftyOne Plugins repository README. |
|
Returns the paths to the fiftyone YAML files for all plugins found in the given GitHub repository. |
|
Returns a dict of plugin info for a FiftyOne plugin hosted in GitHub. |
-
fiftyone.plugins.utils.
list_zoo_plugins
(info=False)¶ Returns a list of available plugins registered in the FiftyOne Plugins repository README.
Example usage:
import fiftyone.plugins.utils as fopu plugins = fopu.list_zoo_plugins() print(plugins) plugins = fopu.list_zoo_plugins(info=True) print(plugins)
- Parameters
info (False) – whether to retrieve full plugin info for each plugin (True) or just return the available info from the README (False)
- Returns
a list of dicts describing the plugins
-
fiftyone.plugins.utils.
find_plugins
(gh_repo, info=False)¶ Returns the paths to the fiftyone YAML files for all plugins found in the given GitHub repository.
Example usage:
import fiftyone.plugins.utils as fopu # Search the entire repository plugins = fopu.find_plugins("https://github.com/voxel51/fiftyone-plugins") print(plugins) # Search a specific tree plugins = fopu.find_plugins("https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/annotation") print(plugins)
- Parameters
gh_repo – a GitHub repository, identifier, or tree root. See
GitHubRepository
for detailsinfo (False) – whether to retrieve full plugin info for each plugin (True) or just return paths to the fiftyone YAML files (False)
- Returns
a list of paths to fiftyone YAML files or plugin info dicts
-
fiftyone.plugins.utils.
get_plugin_info
(gh_repo, path=None)¶ Returns a dict of plugin info for a FiftyOne plugin hosted in GitHub.
Example usage:
import fiftyone.plugins.utils as fopu # Directly link to a repository with a top-level`fiftyone YAML info = fopu.get_plugin_info("https://github.com/voxel51/voxelgpt") print(info) # Provide repository and path separately info = fopu.get_plugin_info( "voxel51/fiftyone-plugins", path="plugins/annotation", ) print(info) # Directly link to a plugin directory info = fopu.get_plugin_info("https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/annotation") print(info) # Directly link to a fiftyone YAML file info = fopu.get_plugin_info("https://github.com/voxel51/fiftyone-plugins/blob/main/plugins/annotation/fiftyone.yml") print(info)
- Parameters
gh_repo – a GitHub repository, identifier, tree root, or blob. See
GitHubRepository
for detailspath (None) – the path to a fiftyone YAML file or the directory that contains it. This is only necessary if the fiftyone YAML file is not at the root of the repository and you have not implicitly included this path in
gh_repo
by providing a tree or blob path
- Returns
a dict or list of dicts of plugin info