fiftyone.core.cli.DatasetZooDownloadCommand

class documentation

class DatasetZooDownloadCommand(Command): (source)

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/<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:

# Download a zoo dataset
fiftyone zoo datasets download <name>

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

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

# Download a zoo dataset that requires extra keyword arguments
fiftyone zoo datasets download <name> \
    --kwargs source_dir=/path/to/source/files

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