fiftyone.core.cli.ModelZooEmbedCommand

class documentation

class ModelZooEmbedCommand(Command): (source)

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

# Generate embeddings for a dataset with a zoo model
fiftyone zoo models embed <model-name> <dataset-name> <embeddings-field>

# Generate embeddings for a dataset with a remotely-sourced zoo model
fiftyone zoo models embed https://github.com/<user>/<repo> \
    <dataset-name> <embeddings-field> --model-name <model-name>
fiftyone zoo models embed <url> \
    <dataset-name> <embeddings-field> --model-name <model-name>

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