fiftyone.core.cli.DatasetZooLoadCommand

class documentation

class DatasetZooLoadCommand(Command): (source)

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/<user>/<repo>
a GitHub ref like https://github.com/<user>/<repo>/tree/<branch> or https://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like <user>/<repo>[/<ref>]
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:

# Load the zoo dataset with the given name
fiftyone zoo datasets load <name>

# Load a remotely-sourced zoo dataset
fiftyone zoo datasets load https://github.com/<user>/<repo>
fiftyone zoo datasets load <url>

# Load the specified split(s) of a zoo dataset
fiftyone zoo datasets load <name> --splits <split1> ...

# Load a zoo dataset with a custom name
fiftyone zoo datasets load <name> --dataset-name <dataset-name>

# Load a zoo dataset that requires custom keyword arguments
fiftyone zoo datasets load <name> \
    --kwargs source_dir=/path/to/source_files

# Load a random subset of a zoo dataset
fiftyone zoo datasets load <name> \
    --kwargs max_samples=50 shuffle=True

Static Method	`execute`	Executes the command on the given args.
Static Method	`setup`	Setup the command-line arguments for the command.

@staticmethod
def execute(parser, args): (source) ¶

overrides fiftyone.core.cli.Command.execute

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

@staticmethod
def setup(parser): (source) ¶

overrides fiftyone.core.cli.Command.setup

Setup the command-line arguments for the command.

Parameters
parser	an `argparse.ArgumentParser` instance