datasetinsights.commands¶

datasetinsights.commands.download¶

datasetinsights download¶

Download datasets to localhost from known locations. The download command can support downloading from 3 sources usim:// http(s):// gs://

Download from Unity Simulation:

You can specify project_it, run_execution_id, access_token in source-uri

datasetinsights download –source-uri=usim://<access_token>@<project_id>/<run_execution_id> –output=$HOME/data

Alternatively, you can also override access_token such as

datasetinsights download –source-uri=usim://<project_id>/<run_execution_id>: –output=$HOME/data –access-token=<access_token>

Downloading from a http source:

datasetinsights download –source-uri=http://url.to.file.zip: –output=$HOME/data

Downloading from a gcs source:

datasetinsights download –source-uri=gs://url/to/file.zip: –output=$HOME/data

or

datasetinsights download –source-uri=gs://url/to/folder: –output=$HOME/data

datasetinsights download [OPTIONS]

Options

-s, --source-uri <source_uri>¶: Required URI of where this data should be downloaded. Supported source uri patterns ^gs://|^http(s)?://|^usim://

-o, --output <output>¶: Directory on localhost where datasets should be downloaded.

-b, --include-binary¶: Whether to download binary files such as images or LIDAR point clouds. This flag applies to Datasets where metadata (e.g. annotation json, dataset catalog, …) can be separated from binary files.

--access-token <access_token>¶: Unity Simulation access token. This will override synthetic datasets source-uri for Unity Simulation

--checksum-file <checksum_file>¶: Dataset checksum text file path. Path can be a HTTP(S) url or a local file path. This will help check the integrity of the downloaded dataset.

class datasetinsights.commands.download.SourceURI¶

Bases: click.types.ParamType

Source URI Parameter.

Parameters: click ([type]) – [description]
Raises: click.BadParameter – [description]
Returns: [description]
Return type: [type]

PREFIX_PATTERN = '^gs://|^http(s)?://|^usim://'¶

convert(value, param, ctx)¶: Validate source URI and Converts the value.

name = 'source_uri'¶

class datasetinsights.commands.Entrypoint(name=None, invoke_without_command=False, no_args_is_help=None, subcommand_metavar=None, chain=False, result_callback=None, **attrs)¶

Bases: click.core.MultiCommand

Click MultiCommand Entrypoint For Datasetinsights CLI

get_command(ctx, name)¶: Dynamically get the command.

list_commands(ctx)¶: Dynamically get the list of commands.