# fiftyone.core.cli Definition of the `fiftyone` command-line interface (CLI). Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`Command`](#fiftyone.core.cli.Command)() | Interface for defining commands. | |---------------------------------------------------------------------------------------|-------------------------------------------------------------------------| | [`FiftyOneCommand`](#fiftyone.core.cli.FiftyOneCommand)() | The FiftyOne command-line interface. | | [`QuickstartCommand`](#fiftyone.core.cli.QuickstartCommand)() | Launch a FiftyOne quickstart. | | [`ConfigCommand`](#fiftyone.core.cli.ConfigCommand)() | Tools for working with your FiftyOne config. | | [`ConstantsCommand`](#fiftyone.core.cli.ConstantsCommand)() | Print constants from `fiftyone.constants`. | | [`ConvertCommand`](#fiftyone.core.cli.ConvertCommand)() | Convert datasets on disk between supported formats. | | [`DatasetsCommand`](#fiftyone.core.cli.DatasetsCommand)() | Tools for working with FiftyOne datasets. | | [`DatasetsListCommand`](#fiftyone.core.cli.DatasetsListCommand)() | List FiftyOne datasets. | | [`DatasetsInfoCommand`](#fiftyone.core.cli.DatasetsInfoCommand)() | Print information about FiftyOne datasets. | | [`DatasetsStatsCommand`](#fiftyone.core.cli.DatasetsStatsCommand)() | Print stats about FiftyOne datasets on disk. | | [`DatasetsCreateCommand`](#fiftyone.core.cli.DatasetsCreateCommand)() | Tools for creating FiftyOne datasets. | | [`DatasetsHeadCommand`](#fiftyone.core.cli.DatasetsHeadCommand)() | Prints the first few samples in a FiftyOne dataset. | | [`DatasetsTailCommand`](#fiftyone.core.cli.DatasetsTailCommand)() | Prints the last few samples in a FiftyOne dataset. | | [`DatasetsStreamCommand`](#fiftyone.core.cli.DatasetsStreamCommand)() | Stream samples in a FiftyOne dataset to the terminal. | | [`DatasetsExportCommand`](#fiftyone.core.cli.DatasetsExportCommand)() | Export FiftyOne datasets to disk in supported formats. | | [`DatasetsDrawCommand`](#fiftyone.core.cli.DatasetsDrawCommand)() | Renders annotated versions of samples in FiftyOne datasets to disk. | | [`DatasetsRenameCommand`](#fiftyone.core.cli.DatasetsRenameCommand)() | Rename FiftyOne datasets. | | [`DatasetsDeleteCommand`](#fiftyone.core.cli.DatasetsDeleteCommand)() | Delete FiftyOne datasets. | | [`AnnotationCommand`](#fiftyone.core.cli.AnnotationCommand)() | Tools for working with the FiftyOne annotation API. | | [`AnnotationConfigCommand`](#fiftyone.core.cli.AnnotationConfigCommand)() | Tools for working with your FiftyOne annotation config. | | [`AppCommand`](#fiftyone.core.cli.AppCommand)() | Tools for working with the FiftyOne App. | | [`AppConfigCommand`](#fiftyone.core.cli.AppConfigCommand)() | Tools for working with your FiftyOne App config. | | [`AppLaunchCommand`](#fiftyone.core.cli.AppLaunchCommand)() | Launch the FiftyOne App. | | [`AppDebugCommand`](#fiftyone.core.cli.AppDebugCommand)() | Launch the FiftyOne App in debug mode. | | [`AppViewCommand`](#fiftyone.core.cli.AppViewCommand)() | View datasets in the App without persisting them to the database. | | [`AppConnectCommand`](#fiftyone.core.cli.AppConnectCommand)() | Connect to a remote FiftyOne App in your web browser. | | [`BrainCommand`](#fiftyone.core.cli.BrainCommand)() | Tools for working with the FiftyOne Brain. | | [`BrainConfigCommand`](#fiftyone.core.cli.BrainConfigCommand)() | Tools for working with your FiftyOne Brain config. | | [`EvaluationCommand`](#fiftyone.core.cli.EvaluationCommand)() | Tools for working with the FiftyOne evaluation API. | | [`EvaluationConfigCommand`](#fiftyone.core.cli.EvaluationConfigCommand)() | Tools for working with your FiftyOne evaluation config. | | [`ZooCommand`](#fiftyone.core.cli.ZooCommand)() | Tools for working with the FiftyOne Zoo. | | [`DatasetZooCommand`](#fiftyone.core.cli.DatasetZooCommand)() | Tools for working with the FiftyOne Dataset Zoo. | | [`DatasetZooListCommand`](#fiftyone.core.cli.DatasetZooListCommand)() | List datasets in the FiftyOne Dataset Zoo. | | [`DatasetZooFindCommand`](#fiftyone.core.cli.DatasetZooFindCommand)() | Locate a downloaded zoo dataset on disk. | | [`DatasetZooInfoCommand`](#fiftyone.core.cli.DatasetZooInfoCommand)() | Print information about datasets in the FiftyOne Dataset Zoo. | | [`DatasetZooDownloadCommand`](#fiftyone.core.cli.DatasetZooDownloadCommand)() | Download zoo datasets. | | [`DatasetZooLoadCommand`](#fiftyone.core.cli.DatasetZooLoadCommand)() | Load zoo datasets as persistent FiftyOne datasets. | | [`DatasetZooDeleteCommand`](#fiftyone.core.cli.DatasetZooDeleteCommand)() | Deletes the local copy of the zoo dataset on disk. | | [`ModelZooCommand`](#fiftyone.core.cli.ModelZooCommand)() | Tools for working with the FiftyOne Model Zoo. | | [`ModelZooListCommand`](#fiftyone.core.cli.ModelZooListCommand)() | List models in the FiftyOne Model Zoo. | | [`ModelZooFindCommand`](#fiftyone.core.cli.ModelZooFindCommand)() | Locate the downloaded zoo model on disk. | | [`ModelZooInfoCommand`](#fiftyone.core.cli.ModelZooInfoCommand)() | Print information about models in the FiftyOne Model Zoo. | | [`ModelZooRequirementsCommand`](#fiftyone.core.cli.ModelZooRequirementsCommand)() | Handles package requirements for zoo models. | | [`ModelZooDownloadCommand`](#fiftyone.core.cli.ModelZooDownloadCommand)() | Download zoo models. | | [`ModelZooApplyCommand`](#fiftyone.core.cli.ModelZooApplyCommand)() | Apply zoo models to datasets. | | [`ModelZooEmbedCommand`](#fiftyone.core.cli.ModelZooEmbedCommand)() | Generate embeddings for datasets with zoo models. | | [`ModelZooDeleteCommand`](#fiftyone.core.cli.ModelZooDeleteCommand)() | Deletes the local copy of the zoo model on disk. | | [`ModelZooListSourcesCommand`](#fiftyone.core.cli.ModelZooListSourcesCommand)() | Lists remote zoo model sources that are registered locally. | | [`ModelZooRegisterSourceCommand`](#fiftyone.core.cli.ModelZooRegisterSourceCommand)() | Registers a remote source of zoo models. | | [`ModelZooDeleteSourceCommand`](#fiftyone.core.cli.ModelZooDeleteSourceCommand)() | Deletes the remote source and all downloaded models associated with it. | | [`OperatorsCommand`](#fiftyone.core.cli.OperatorsCommand)() | Tools for working with FiftyOne operators and panels. | | [`OperatorsListCommand`](#fiftyone.core.cli.OperatorsListCommand)() | List operators and panels that are installed locally. | | [`OperatorsInfoCommand`](#fiftyone.core.cli.OperatorsInfoCommand)() | Prints info about operators and panels that are installed locally. | | [`DelegatedCommand`](#fiftyone.core.cli.DelegatedCommand)() | Tools for working with FiftyOne delegated operations. | | [`DelegatedRerunCommand`](#fiftyone.core.cli.DelegatedRerunCommand)() | Rerun delegated operations | | [`DelegatedLaunchCommand`](#fiftyone.core.cli.DelegatedLaunchCommand)() | Launches a service for running delegated operations. | | [`DelegatedListCommand`](#fiftyone.core.cli.DelegatedListCommand)() | List delegated operations. | | [`DelegatedInfoCommand`](#fiftyone.core.cli.DelegatedInfoCommand)() | Prints information about a delegated operation. | | [`DelegatedOutputCommand`](#fiftyone.core.cli.DelegatedOutputCommand)() | Prints the output for a delegated operation. | | [`DelegatedFailCommand`](#fiftyone.core.cli.DelegatedFailCommand)() | Manually mark delegated operations as failed. | | [`DelegatedDeleteCommand`](#fiftyone.core.cli.DelegatedDeleteCommand)() | Delete delegated operations. | | [`DelegatedArchiveCommand`](#fiftyone.core.cli.DelegatedArchiveCommand)() | Archive delegated operations. | | [`DelegatedCleanupCommand`](#fiftyone.core.cli.DelegatedCleanupCommand)() | Cleanup delegated operations. | | [`PluginsCommand`](#fiftyone.core.cli.PluginsCommand)() | Tools for working with FiftyOne plugins. | | [`PluginsListCommand`](#fiftyone.core.cli.PluginsListCommand)() | List plugins that are installed locally. | | [`PluginsInfoCommand`](#fiftyone.core.cli.PluginsInfoCommand)() | Prints info about plugins that are installed locally. | | [`PluginsDownloadCommand`](#fiftyone.core.cli.PluginsDownloadCommand)() | Download plugins from the web. | | [`PluginsSearchCommand`](#fiftyone.core.cli.PluginsSearchCommand)() | Search for available plugins in a GitHub repository. | | [`PluginsRequirementsCommand`](#fiftyone.core.cli.PluginsRequirementsCommand)() | Handles package requirements for plugins. | | [`PluginsCreateCommand`](#fiftyone.core.cli.PluginsCreateCommand)() | Creates or initializes a plugin. | | [`PluginsEnableCommand`](#fiftyone.core.cli.PluginsEnableCommand)() | Enables the given plugin(s). | | [`PluginsDisableCommand`](#fiftyone.core.cli.PluginsDisableCommand)() | Disables the given plugin(s). | | [`PluginsDeleteCommand`](#fiftyone.core.cli.PluginsDeleteCommand)() | Delete plugins from your local machine. | | [`SkillsCommand`](#fiftyone.core.cli.SkillsCommand)() | Tools for working with FiftyOne skills. | | [`SkillsListCommand`](#fiftyone.core.cli.SkillsListCommand)() | List skills provided by installed plugins. | | [`LabsCommand`](#fiftyone.core.cli.LabsCommand)() | Tools for working with FiftyOne Labs. | | [`LabsInstallCommand`](#fiftyone.core.cli.LabsInstallCommand)() | Install FiftyOne Labs features on your local machine. | | [`LabsUninstallCommand`](#fiftyone.core.cli.LabsUninstallCommand)() | Uninstall FiftyOne Labs features from your local machine. | | [`LabsListCommand`](#fiftyone.core.cli.LabsListCommand)() | List installed FiftyOne Labs features on your local machine. | | [`LabsSearchCommand`](#fiftyone.core.cli.LabsSearchCommand)() | Search for available FiftyOne Labs features. | | [`MigrateCommand`](#fiftyone.core.cli.MigrateCommand)() | Tools for migrating the FiftyOne database. | | [`UtilsCommand`](#fiftyone.core.cli.UtilsCommand)() | FiftyOne utilities. | | [`ComputeMetadataCommand`](#fiftyone.core.cli.ComputeMetadataCommand)() | Populates the `metadata` field of all samples in the dataset. | | [`TransformImagesCommand`](#fiftyone.core.cli.TransformImagesCommand)() | Transforms the images in a dataset per the specified parameters. | | [`TransformVideosCommand`](#fiftyone.core.cli.TransformVideosCommand)() | Transforms the videos in a dataset per the specified parameters. | **Functions:** | [`main`](#fiftyone.core.cli.main)() | Executes the `fiftyone` tool with the given command-line args. | |---------------------------------------|------------------------------------------------------------------| ### *class* fiftyone.core.cli.Command Bases: `object` Interface for defining commands. Command instances must implement the `setup()` method, and they should implement the `execute()` method if they perform any functionality beyond defining subparsers. **Methods:** | [`setup`](#fiftyone.core.cli.Command.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.Command.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.FiftyOneCommand Bases: [`Command`](#fiftyone.core.cli.Command) The FiftyOne command-line interface. **Methods:** | [`setup`](#fiftyone.core.cli.FiftyOneCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.FiftyOneCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.QuickstartCommand Bases: [`Command`](#fiftyone.core.cli.Command) Launch a FiftyOne quickstart. Examples: ```default # Launch the quickstart fiftyone quickstart # Launch the quickstart with a video dataset fiftyone quickstart --video # Launch the quickstart as a remote session fiftyone quickstart --remote ``` **Methods:** | [`setup`](#fiftyone.core.cli.QuickstartCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.QuickstartCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ConfigCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with your FiftyOne config. Examples: ```default # Print your entire config fiftyone config # Print a specific config field fiftyone config # Print the location of your config on disk (if one exists) fiftyone config --locate ``` **Methods:** | [`setup`](#fiftyone.core.cli.ConfigCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ConfigCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ConstantsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Print constants from `fiftyone.constants`. Examples: ```default # Print all constants fiftyone constants # Print a specific constant fiftyone constants ``` **Methods:** | [`setup`](#fiftyone.core.cli.ConstantsCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ConstantsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ConvertCommand Bases: [`Command`](#fiftyone.core.cli.Command) Convert datasets on disk between supported formats. Examples: ```default # Convert an image classification directory tree to TFRecords format fiftyone convert \ --input-dir /path/to/image-classification-directory-tree \ --input-type fiftyone.types.ImageClassificationDirectoryTree \ --output-dir /path/for/tf-image-classification-dataset \ --output-type fiftyone.types.TFImageClassificationDataset # Convert a COCO detection dataset to CVAT image format fiftyone convert \ --input-dir /path/to/coco-detection-dataset \ --input-type fiftyone.types.COCODetectionDataset \ --output-dir /path/for/cvat-image-dataset \ --output-type fiftyone.types.CVATImageDataset # Perform a customized conversion via optional kwargs fiftyone convert \ --input-dir /path/to/coco-detection-dataset \ --input-type fiftyone.types.COCODetectionDataset \ --input-kwargs max_samples=100 shuffle=True \ --output-dir /path/for/cvat-image-dataset \ --output-type fiftyone.types.TFObjectDetectionDataset \ --output-kwargs force_rgb=True \ --overwrite ``` **Methods:** | [`setup`](#fiftyone.core.cli.ConvertCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ConvertCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne datasets. **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List FiftyOne datasets. Examples: ```default # List available datasets fiftyone datasets list # List datasets matching a given pattern fiftyone datasets list --glob-patt 'quickstart-*' # List datasets with the given tag(s) fiftyone datasets list --tags automotive healthcare ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsListCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Print information about FiftyOne datasets. Examples: ```default # Print basic information about multiple datasets fiftyone datasets info fiftyone datasets info --glob-patt 'quickstart-*' fiftyone datasets info --tags automotive healthcare fiftyone datasets info --sort-by created_at fiftyone datasets info --sort-by name --reverse # Print information about a specific dataset fiftyone datasets info ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsStatsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Print stats about FiftyOne datasets on disk. Examples: ```default # Print stats about the given dataset on disk fiftyone datasets stats ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsStatsCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsStatsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsCreateCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for creating FiftyOne datasets. Examples: ```default # Create a dataset from the given data on disk fiftyone datasets create \ --name --dataset-dir --type # Create a dataset from a random subset of the data on disk fiftyone datasets create \ --name --dataset-dir --type \ --kwargs max_samples=50 shuffle=True # Create a dataset from the given samples JSON file fiftyone datasets create --json-path ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsCreateCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsCreateCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsHeadCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints the first few samples in a FiftyOne dataset. Examples: ```default # Print the first few samples in a dataset fiftyone datasets head # Print the given number of samples from the head of a dataset fiftyone datasets head --num-samples ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsHeadCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsHeadCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsTailCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints the last few samples in a FiftyOne dataset. Examples: ```default # Print the last few samples in a dataset fiftyone datasets tail # Print the given number of samples from the tail of a dataset fiftyone datasets tail --num-samples ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsTailCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsTailCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsStreamCommand Bases: [`Command`](#fiftyone.core.cli.Command) Stream samples in a FiftyOne dataset to the terminal. Examples: ```default # Stream the samples of the dataset to the terminal fiftyone datasets stream ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsStreamCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsStreamCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsExportCommand Bases: [`Command`](#fiftyone.core.cli.Command) Export FiftyOne datasets to disk in supported formats. Examples: ```default # Export the dataset to disk in the specified format fiftyone datasets export \ --export-dir --type --label-field # Export the dataset to disk in JSON format fiftyone datasets export --json-path # Only export cats and dogs from the validation split fiftyone datasets export \ --filters tags=validation ground_truth=cat,dog \ --export-dir --type --label-field ground_truth # Perform a customized export of a dataset fiftyone datasets export \ --type \ --kwargs labels_path=/path/for/labels.json ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsExportCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsExportCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsDrawCommand Bases: [`Command`](#fiftyone.core.cli.Command) Renders annotated versions of samples in FiftyOne datasets to disk. Examples: ```default # Write annotated versions of the media in the dataset with the # specified label field(s) overlaid to disk fiftyone datasets draw \ --output-dir --label-fields ,, ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsDrawCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsDrawCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsRenameCommand Bases: [`Command`](#fiftyone.core.cli.Command) Rename FiftyOne datasets. Examples: ```default # Rename the dataset fiftyone datasets rename ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsRenameCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsRenameCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetsDeleteCommand Bases: [`Command`](#fiftyone.core.cli.Command) Delete FiftyOne datasets. Examples: ```default # Delete the datasets with the given name(s) fiftyone datasets delete ... # Delete the datasets whose names match the given glob pattern fiftyone datasets delete --glob-patt # Delete all non-persistent datasets fiftyone datasets delete --non-persistent ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetsDeleteCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetsDeleteCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AnnotationCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne annotation API. **Methods:** | [`setup`](#fiftyone.core.cli.AnnotationCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AnnotationCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AnnotationConfigCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with your FiftyOne annotation config. Examples: ```default # Print your entire annotation config fiftyone annotation config # Print a specific annotation config field fiftyone annotation config # Print the location of your annotation config on disk (if one exists) fiftyone annotation config --locate ``` **Methods:** | [`setup`](#fiftyone.core.cli.AnnotationConfigCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AnnotationConfigCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne App. **Methods:** | [`setup`](#fiftyone.core.cli.AppCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppConfigCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with your FiftyOne App config. Examples: ```default # Print your entire App config fiftyone app config # Print a specific App config field fiftyone app config # Print the location of your App config on disk (if one exists) fiftyone app config --locate ``` **Methods:** | [`setup`](#fiftyone.core.cli.AppConfigCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppConfigCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppLaunchCommand Bases: [`Command`](#fiftyone.core.cli.Command) Launch the FiftyOne App. Examples: ```default # Launch the App fiftyone app launch # Launch the App with the given dataset loaded fiftyone app launch # Launch a remote App session fiftyone app launch ... --remote # Launch the App in the non-default browser fiftyone app launch ... --browser firefox ``` **Methods:** | [`setup`](#fiftyone.core.cli.AppLaunchCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppLaunchCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppDebugCommand Bases: [`Command`](#fiftyone.core.cli.Command) Launch the FiftyOne App in debug mode. Examples: ```default # Launch the App in debug mode fiftyone app debug # Launch the App in debug mode with a given dataset loaded fiftyone app debug ``` **Methods:** | [`setup`](#fiftyone.core.cli.AppDebugCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppDebugCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppViewCommand Bases: [`Command`](#fiftyone.core.cli.Command) View datasets in the App without persisting them to the database. Examples: ```default # View a dataset stored on disk in the App fiftyone app view --dataset-dir --type # View a zoo dataset in the App fiftyone app view --zoo-dataset --splits ... # View a directory of images in the App fiftyone app view --images-dir # View a glob pattern of images in the App fiftyone app view --images-patt # View a directory of videos in the App fiftyone app view --videos-dir # View a glob pattern of videos in the App fiftyone app view --videos-patt # View a dataset stored in JSON format on disk in the App fiftyone app view --json-path # View the dataset in a remote App session fiftyone app view ... --remote # View a random subset of the data stored on disk in the App fiftyone app view ... --kwargs max_samples=50 shuffle=True ``` **Methods:** | [`setup`](#fiftyone.core.cli.AppViewCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppViewCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.AppConnectCommand Bases: [`Command`](#fiftyone.core.cli.Command) Connect to a remote FiftyOne App in your web browser. Examples: ```default # Connect to a remote App with port forwarding already configured fiftyone app connect # Connect to a remote App session fiftyone app connect --destination --port # Connect to a remote App session using an ssh key fiftyone app connect ... --ssh-key # Connect to a remote App using a custom local port fiftyone app connect ... --local-port ``` **Methods:** | [`setup`](#fiftyone.core.cli.AppConnectCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.AppConnectCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.BrainCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne Brain. **Methods:** | [`setup`](#fiftyone.core.cli.BrainCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.BrainCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.BrainConfigCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with your FiftyOne Brain config. Examples: ```default # Print your entire brain config fiftyone brain config # Print a specific brain config field fiftyone brain config # Print the location of your brain config on disk (if one exists) fiftyone brain config --locate ``` **Methods:** | [`setup`](#fiftyone.core.cli.BrainConfigCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.BrainConfigCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.EvaluationCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne evaluation API. **Methods:** | [`setup`](#fiftyone.core.cli.EvaluationCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.EvaluationCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.EvaluationConfigCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with your FiftyOne evaluation config. Examples: ```default # Print your entire evaluation config fiftyone evaluation config # Print a specific evaluation config field fiftyone evaluation config # Print the location of your evaluation config on disk (if one exists) fiftyone evaluation config --locate ``` **Methods:** | [`setup`](#fiftyone.core.cli.EvaluationConfigCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.EvaluationConfigCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ZooCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne Zoo. **Methods:** | [`setup`](#fiftyone.core.cli.ZooCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ZooCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne Dataset Zoo. **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List datasets in the FiftyOne Dataset Zoo. Examples: ```default # List available datasets fiftyone zoo datasets list # List available dataset names fiftyone zoo datasets list --names-only # List downloaded datasets fiftyone zoo datasets list --downloaded-only # List available datasets from the given source fiftyone zoo datasets list --source # List available datasets with the given tag fiftyone zoo datasets list --tags # List available datasets with the given license fiftyone zoo datasets list --license ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooListCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooFindCommand Bases: [`Command`](#fiftyone.core.cli.Command) Locate a downloaded zoo dataset on disk. Examples: ```default # Print the location of a downloaded zoo dataset on disk fiftyone zoo datasets find # Print the location of a remotely-sourced zoo dataset on disk fiftyone zoo datasets find https://github.com// fiftyone zoo datasets find # Print the location of a specific split of a dataset fiftyone zoo datasets find --split ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooFindCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooFindCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Print information about datasets in the FiftyOne Dataset Zoo. Examples: ```default # Print information about a zoo dataset fiftyone zoo datasets info # Print information about a remote zoo dataset fiftyone zoo datasets info https://github.com// fiftyone zoo datasets info ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooDownloadCommand Bases: [`Command`](#fiftyone.core.cli.Command) Download zoo datasets. When downloading remotely-sourced zoo datasets, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Download a zoo dataset fiftyone zoo datasets download # Download a remotely-sourced zoo dataset fiftyone zoo datasets download https://github.com// fiftyone zoo datasets download # Download the specified split(s) of a zoo dataset fiftyone zoo datasets download --splits ... # Download a zoo dataset that requires extra keyword arguments fiftyone zoo datasets download \ --kwargs source_dir=/path/to/source/files ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooDownloadCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooDownloadCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooLoadCommand Bases: [`Command`](#fiftyone.core.cli.Command) Load zoo datasets as persistent FiftyOne datasets. When loading remotely-sourced zoo datasets, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Load the zoo dataset with the given name fiftyone zoo datasets load # Load a remotely-sourced zoo dataset fiftyone zoo datasets load https://github.com// fiftyone zoo datasets load # Load the specified split(s) of a zoo dataset fiftyone zoo datasets load --splits ... # Load a zoo dataset with a custom name fiftyone zoo datasets load --dataset-name # Load a zoo dataset that requires custom keyword arguments fiftyone zoo datasets load \ --kwargs source_dir=/path/to/source_files # Load a random subset of a zoo dataset fiftyone zoo datasets load \ --kwargs max_samples=50 shuffle=True ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooLoadCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooLoadCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DatasetZooDeleteCommand Bases: [`Command`](#fiftyone.core.cli.Command) Deletes the local copy of the zoo dataset on disk. Examples: ```default # Delete a zoo dataset from disk fiftyone zoo datasets delete # Delete a remotely-sourced zoo dataset from disk fiftyone zoo datasets delete https://github.com// fiftyone zoo datasets delete # Delete a specific split of a zoo dataset from disk fiftyone zoo datasets delete --split ``` **Methods:** | [`setup`](#fiftyone.core.cli.DatasetZooDeleteCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DatasetZooDeleteCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with the FiftyOne Model Zoo. **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List models in the FiftyOne Model Zoo. Examples: ```default # List available models fiftyone zoo models list # List available models (names only) fiftyone zoo models list --names-only # List downloaded models fiftyone zoo models list --downloaded-only # List available models with the given tag fiftyone zoo models list --tags # List available models from the given remote source fiftyone zoo models list --source # List available models with the given license fiftyone zoo models list --license ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooListCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooFindCommand Bases: [`Command`](#fiftyone.core.cli.Command) Locate the downloaded zoo model on disk. Examples: ```default # Print the location of the downloaded zoo model on disk fiftyone zoo models find ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooFindCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooFindCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Print information about models in the FiftyOne Model Zoo. Examples: ```default # Print information about a zoo model fiftyone zoo models info ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooRequirementsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Handles package requirements for zoo models. Examples: ```default # Print requirements for a zoo model fiftyone zoo models requirements --print # Install any requirements for the zoo model fiftyone zoo models requirements --install # Ensures that the requirements for the zoo model are satisfied fiftyone zoo models requirements --ensure ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooRequirementsCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooRequirementsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooDownloadCommand Bases: [`Command`](#fiftyone.core.cli.Command) Download zoo models. When downloading remotely-sourced zoo models, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Download a zoo model fiftyone zoo models download # Download a remotely-sourced zoo model fiftyone zoo models download https://github.com// \ --model-name fiftyone zoo models download --model-name ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooDownloadCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooDownloadCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooApplyCommand Bases: [`Command`](#fiftyone.core.cli.Command) Apply zoo models to datasets. When applying remotely-sourced zoo models, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Apply a zoo model to a dataset fiftyone zoo models apply # Apply a remotely-sourced zoo model to a dataset fiftyone zoo models apply https://github.com// \ --model-name fiftyone zoo models apply \ --model-name # Apply a zoo model with some customized parameters fiftyone zoo models apply \ \ --confidence-thresh 0.7 \ --store-logits \ --batch-size 32 ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooApplyCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooApplyCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooEmbedCommand Bases: [`Command`](#fiftyone.core.cli.Command) Generate embeddings for datasets with zoo models. When applying remotely-sourced zoo models, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Generate embeddings for a dataset with a zoo model fiftyone zoo models embed # Generate embeddings for a dataset with a remotely-sourced zoo model fiftyone zoo models embed https://github.com// \ --model-name fiftyone zoo models embed \ --model-name ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooEmbedCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooEmbedCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooDeleteCommand Bases: [`Command`](#fiftyone.core.cli.Command) Deletes the local copy of the zoo model on disk. Examples: ```default # Delete the zoo model from disk fiftyone zoo models delete ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooDeleteCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooDeleteCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooListSourcesCommand Bases: [`Command`](#fiftyone.core.cli.Command) Lists remote zoo model sources that are registered locally. Examples: ```default # Lists the registered remote zoo model sources fiftyone zoo models list-sources ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooListSourcesCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooListSourcesCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooRegisterSourceCommand Bases: [`Command`](#fiftyone.core.cli.Command) Registers a remote source of zoo models. You can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Register a remote zoo model source fiftyone zoo models register-source https://github.com// fiftyone zoo models register-source ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooRegisterSourceCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooRegisterSourceCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ModelZooDeleteSourceCommand Bases: [`Command`](#fiftyone.core.cli.Command) Deletes the remote source and all downloaded models associated with it. You can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` - a publicly accessible URL of an archive (eg zip or tar) file Examples: ```default # Delete a remote zoo model source fiftyone zoo models delete-source https://github.com// fiftyone zoo models delete-source ``` **Methods:** | [`setup`](#fiftyone.core.cli.ModelZooDeleteSourceCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ModelZooDeleteSourceCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.OperatorsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne operators and panels. **Methods:** | [`setup`](#fiftyone.core.cli.OperatorsCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.OperatorsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.OperatorsListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List operators and panels that are installed locally. Examples: ```default # List all available operators and panels fiftyone operators list # List operators and panels whose URI matches the given glob pattern fiftyone operators list --glob-patt '*/compute_*' # List enabled operators and panels fiftyone operators list --enabled # List disabled operators and panels fiftyone operators list --disabled # List non-builtin operators and panels fiftyone operators list --no-builtins # List panels fiftyone operators list --panels-only ``` **Methods:** | [`setup`](#fiftyone.core.cli.OperatorsListCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.OperatorsListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.OperatorsInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints info about operators and panels that are installed locally. Examples: ```default # Prints information about an operator or panel fiftyone operators info ``` **Methods:** | [`setup`](#fiftyone.core.cli.OperatorsInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.OperatorsInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne delegated operations. **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedRerunCommand Bases: [`Command`](#fiftyone.core.cli.Command) Rerun delegated operations Examples: ```default # Rerun the given operation id fiftyone delegated rerun ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedRerunCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedRerunCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedLaunchCommand Bases: [`Command`](#fiftyone.core.cli.Command) Launches a service for running delegated operations. Examples: ```default # Launch a local service fiftyone delegated launch ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedLaunchCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedLaunchCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List delegated operations. Examples: ```default # List all delegated operations fiftyone delegated list # List some specific delegated operations fiftyone delegated list \ --dataset quickstart \ --operator @voxel51/io/export_samples \ --state COMPLETED \ --sort-by COMPLETED_AT \ --limit 10 ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedListCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints information about a delegated operation. Examples: ```default # Print information about a delegated operation fiftyone delegated info ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedOutputCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints the output for a delegated operation. Examples: ```default # Print the output for a delegated operation fiftyone delegated output ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedOutputCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedOutputCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedFailCommand Bases: [`Command`](#fiftyone.core.cli.Command) Manually mark delegated operations as failed. Examples: ```default # Manually mark the specified operation(s) as FAILED fiftyone delegated fail ... ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedFailCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedFailCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedDeleteCommand Bases: [`Command`](#fiftyone.core.cli.Command) Delete delegated operations. Examples: ```default # Delete the specified operation(s) fiftyone delegated delete ... ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedDeleteCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedDeleteCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedArchiveCommand Bases: [`Command`](#fiftyone.core.cli.Command) Archive delegated operations. Examples: ```default # Archive the specified operation(s) fiftyone delegated archive ... # Unarchive the specified operation(s) fiftyone delegated archive ... --unarchive ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedArchiveCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedArchiveCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.DelegatedCleanupCommand Bases: [`Command`](#fiftyone.core.cli.Command) Cleanup delegated operations. Examples: ```default # Delete all failed operations associated with a given dataset fiftyone delegated cleanup --dataset quickstart --state FAILED # Delete all delegated operations associated with non-existent datasets fiftyone delegated cleanup --orphan # Print information about operations rather than actually deleting them fiftyone delegated cleanup --orphan --dry-run ``` **Methods:** | [`setup`](#fiftyone.core.cli.DelegatedCleanupCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.DelegatedCleanupCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne plugins. **Methods:** | [`setup`](#fiftyone.core.cli.PluginsCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List plugins that are installed locally. Examples: ```default # List all available plugins fiftyone plugins list # List plugins whose name matches the given glob pattern fiftyone plugins list --glob-patt '@voxel51/*' # List plugins with the given tag fiftyone plugins list --tags # List enabled plugins fiftyone plugins list --enabled # List disabled plugins fiftyone plugins list --disabled # List non-builtin plugins fiftyone plugins list --no-builtins ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsListCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsInfoCommand Bases: [`Command`](#fiftyone.core.cli.Command) Prints info about plugins that are installed locally. Examples: ```default # Prints information about a plugin fiftyone plugins info # Prints information about a plugin in a given directory fiftyone plugins info ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsInfoCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsInfoCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsDownloadCommand Bases: [`Command`](#fiftyone.core.cli.Command) Download plugins from the web. When downloading plugins from GitHub, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Download plugins from a GitHub repository URL fiftyone plugins download # Download plugins by specifying the GitHub repository details fiftyone plugins download /[/] # Download specific plugins from a URL fiftyone plugins download --plugin-names ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsDownloadCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsDownloadCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsSearchCommand Bases: [`Command`](#fiftyone.core.cli.Command) Search for available plugins in a GitHub repository. When searching for plugins, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` #### NOTE To read from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. Examples: ```default # Search for plugins by specifying a GitHub repository URL fiftyone plugins search # Search for plugins by specifying the GitHub repository details fiftyone plugins search /[/] # Search for plugins by specifying a path inside the repository fiftyone plugins search --path path/to/dir fiftyone plugins search /[/] --path path/to/dir ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsSearchCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsSearchCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsRequirementsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Handles package requirements for plugins. Examples: ```default # Print requirements for a plugin fiftyone plugins requirements --print # Install any requirements for the plugin fiftyone plugins requirements --install # Ensures that the requirements for the plugin are satisfied fiftyone plugins requirements --ensure ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsRequirementsCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsRequirementsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsCreateCommand Bases: [`Command`](#fiftyone.core.cli.Command) Creates or initializes a plugin. Examples: ```default # Initialize a new plugin fiftyone plugins create # Create a plugin from existing files fiftyone plugins create \ \ --from-files /path/to/dir \ --description ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsCreateCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsCreateCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsEnableCommand Bases: [`Command`](#fiftyone.core.cli.Command) Enables the given plugin(s). Examples: ```default # Enable a plugin fiftyone plugins enable # Enable multiple plugins fiftyone plugins enable ... # Enable all plugins fiftyone plugins enable --all ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsEnableCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsEnableCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsDisableCommand Bases: [`Command`](#fiftyone.core.cli.Command) Disables the given plugin(s). Examples: ```default # Disable a plugin fiftyone plugins disable # Disable multiple plugins fiftyone plugins disable ... # Disable all plugins fiftyone plugins disable --all ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsDisableCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsDisableCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.PluginsDeleteCommand Bases: [`Command`](#fiftyone.core.cli.Command) Delete plugins from your local machine. Examples: ```default # Delete a plugin from local disk fiftyone plugins delete # Delete multiple plugins from local disk fiftyone plugins delete ... # Delete all plugins from local disk fiftyone plugins delete --all ``` **Methods:** | [`setup`](#fiftyone.core.cli.PluginsDeleteCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.PluginsDeleteCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.SkillsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne skills. **Methods:** | [`setup`](#fiftyone.core.cli.SkillsCommand.setup)(parser) | Setup the command-line arguments for the command. | |---------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.SkillsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.SkillsListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List skills provided by installed plugins. Examples: ```default # List all available skills fiftyone skills list # List skills from a specific plugin fiftyone skills list --plugin @voxel51/my-plugin # List skills in a specific category fiftyone skills list --category data-ingestion # List enabled skills fiftyone skills list --enabled # List skill names only fiftyone skills list --names-only ``` **Methods:** | [`setup`](#fiftyone.core.cli.SkillsListCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.SkillsListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.LabsCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for working with FiftyOne Labs. **Methods:** | [`setup`](#fiftyone.core.cli.LabsCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.LabsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.LabsInstallCommand Bases: [`Command`](#fiftyone.core.cli.Command) Install FiftyOne Labs features on your local machine. Examples: ```default # Install specific FiftyOne labs feature(s) fiftyone labs install ... # Install all FiftyOne Labs features fiftyone labs install --all ``` **Methods:** | [`setup`](#fiftyone.core.cli.LabsInstallCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.LabsInstallCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.LabsUninstallCommand Bases: [`Command`](#fiftyone.core.cli.Command) Uninstall FiftyOne Labs features from your local machine. Examples: ```default # Uninstall specific Labs feature(s) fiftyone labs uninstall ... # Uninstall all Labs features fiftyone labs uninstall --all ``` **Methods:** | [`setup`](#fiftyone.core.cli.LabsUninstallCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.LabsUninstallCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.LabsListCommand Bases: [`Command`](#fiftyone.core.cli.Command) List installed FiftyOne Labs features on your local machine. Examples: ```default # List installed Labs features fiftyone labs list ``` **Methods:** | [`setup`](#fiftyone.core.cli.LabsListCommand.setup)(parser) | Setup the command-line arguments for the command. | |-----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.LabsListCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.LabsSearchCommand Bases: [`Command`](#fiftyone.core.cli.Command) Search for available FiftyOne Labs features. Examples: ```default # List available Labs features fiftyone labs search # List available Labs features in a specific Labs repository branch fiftyone labs search --branch # List available Labs features in a specific Labs repository directory fiftyone labs search --path path/to/dir ``` **Methods:** | [`setup`](#fiftyone.core.cli.LabsSearchCommand.setup)(parser) | Setup the command-line arguments for the command. | |-------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.LabsSearchCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.MigrateCommand Bases: [`Command`](#fiftyone.core.cli.Command) Tools for migrating the FiftyOne database. See [this page](../user_guide/config.md#database-migrations) for more information about migrating FiftyOne deployments. Examples: ```default # Print information about the current revisions of all datasets fiftyone migrate --info # Migrate the database and all datasets to the current client version fiftyone migrate --all # Migrate to a specific revision fiftyone migrate --all --version # Migrate a specific dataset fiftyone migrate ... --dataset-name # Update the database version without migrating any existing datasets fiftyone migrate ``` **Methods:** | [`setup`](#fiftyone.core.cli.MigrateCommand.setup)(parser) | Setup the command-line arguments for the command. | |----------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.MigrateCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.UtilsCommand Bases: [`Command`](#fiftyone.core.cli.Command) FiftyOne utilities. **Methods:** | [`setup`](#fiftyone.core.cli.UtilsCommand.setup)(parser) | Setup the command-line arguments for the command. | |--------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.UtilsCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.ComputeMetadataCommand Bases: [`Command`](#fiftyone.core.cli.Command) Populates the `metadata` field of all samples in the dataset. Examples: ```default # Populate all missing `metadata` sample fields fiftyone utils compute-metadata # (Re)-populate the `metadata` field for all samples fiftyone utils compute-metadata --overwrite ``` **Methods:** | [`setup`](#fiftyone.core.cli.ComputeMetadataCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.ComputeMetadataCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.TransformImagesCommand Bases: [`Command`](#fiftyone.core.cli.Command) Transforms the images in a dataset per the specified parameters. Examples: ```default # Convert the images in the dataset to PNGs fiftyone utils transform-images --ext .png --delete-originals # Ensure that no images in the dataset exceed 1920 x 1080 fiftyone utils transform-images --max-size 1920,1080 ``` **Methods:** | [`setup`](#fiftyone.core.cli.TransformImagesCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.TransformImagesCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### *class* fiftyone.core.cli.TransformVideosCommand Bases: [`Command`](#fiftyone.core.cli.Command) Transforms the videos in a dataset per the specified parameters. Examples: ```default # Re-encode the videos in the dataset as H.264 MP4s fiftyone utils transform-videos --reencode # Ensure that no videos in the dataset exceed 1920 x 1080 and 30fps fiftyone utils transform-videos \ --max-size 1920,1080 --max-fps 30.0 ``` **Methods:** | [`setup`](#fiftyone.core.cli.TransformVideosCommand.setup)(parser) | Setup the command-line arguments for the command. | |------------------------------------------------------------------------------|-----------------------------------------------------| | [`execute`](#fiftyone.core.cli.TransformVideosCommand.execute)(parser, args) | Executes the command on the given args. | #### *static* setup(parser) Setup the command-line arguments for the command. * **Parameters:** **parser** – an `argparse.ArgumentParser` instance #### *static* execute(parser, args) Executes the command on the given args. * **Parameters:** * **parser** – the `argparse.ArgumentParser` instance for the command * **args** – an `argparse.Namespace` instance containing the arguments for the command ### fiftyone.core.cli.main() Executes the `fiftyone` tool with the given command-line args.