simforge datasets

Reference for simforge datasets: usage, arguments and flags, generated from the CLI.

Generated from the CLI’s own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the command reference.

datasets copy

Copy scenarios of a dataset shared with every workspace (SIMLOG-25k) into one of your datasets

simforge datasets copy [OPTIONS] <DATASET>

Argument / flag	Notes	What
<dataset>	required	The dataset id
--filter FILTER		Library filters as key:value (repeat a key or comma-separate values), e.g. ‘grade:A tag:cut-in’
--q Q		Free-text search, as in the library’s search box
--source-log SOURCE_LOG		Only the scenarios of one recorded drive (its recording digest or source id)
--ids IDS	repeatable	Exactly these scenarios (document ids, comma-separated)
--into INTO		Copy into this dataset of your workspace (its id). This or —new is required, except with —dry-run
--new NEW		Copy into a new dataset of this name. This or —into is required, except with —dry-run
--detach		Start the copy and print it without waiting

datasets copy-status

One copy: its state and counts (copied, skipped as already there, failed)

simforge datasets copy-status [OPTIONS] <ID>

Argument / flag	Notes	What
<id>	required	The id

datasets list

List your workspace’s hosted datasets and the ones SimForge shares with every workspace (shared, readOnly, owner)

simforge datasets list [OPTIONS]

Argument / flag	Notes	What
--limit LIMIT	default 20	At most this many items on the page
--cursor CURSOR		The next page: the nextCursor of the page before it
--shared		Only the datasets SimForge shares with every workspace (read-only; datasets copy copies their scenarios)

datasets pull

Download a dataset, a filter of it or chosen scenarios as files (resumable; —dry-run sizes it)

simforge datasets pull [OPTIONS] <DATASET>

Argument / flag	Notes	What
<dataset>	required	The dataset id (simforge datasets list)
--filter FILTER		Library filters as key:value (repeat a key or comma-separate values), e.g. ‘grade:A tag:cut-in’
--q Q		Free-text search, as in the library’s search box
--source-log SOURCE_LOG		Only the scenarios of one recorded drive (its recording digest or source id)
--ids IDS	repeatable	Exactly these scenarios (document ids, comma-separated)
--include INCLUDE	repeatable	Beside each scenario’s document, OpenSCENARIO, trace and resolution: renders[:training|showcase|schematic], labels, gt, recordings (default renders:training; scenarios alone for nothing else)
--passes PASSES	repeatable	Keep only these render modalities: rgb, depth, semantic, instance, lidar, radar
--out OUT		The folder to pull into (required unless —dry-run). Pulling again into it resumes
--jobs JOBS	default 8	Parallel downloads
--wait-pending WAIT_PENDING	default 1800	Seconds to wait for files the platform is still preparing before giving up on them

datasets show

One hosted dataset

simforge datasets show [OPTIONS] <ID>

Argument / flag	Notes	What
<id>	required	The id

datasets verify

Check a pulled folder against its manifest.json and SHA256SUMS (offline)

simforge datasets verify [OPTIONS] <DIR>

Argument / flag	Notes	What
<dir>	required	The pulled folder