On this page
Generated straight from the real
sensym argparse tree, and a test fails if this page and the CLI disagree — every flag below is what the CLI actually accepts. The .dmg download includes this CLI, but it isn't on your shell's PATH by default: run it as /Applications/SenSym Data Factory.app/Contents/Resources/python/bin/sensym, or add that path to your shell profile. (Building from source instead puts a plain sensym on PATH automatically.)Current version: 0.1.0.dev0. Run sensym --version for the version actually
installed.
sensym#
Generate synthetic datasets from a recipe.
usage: sensym [-h] [--version] {generate,validate,schema,models} ...
Generate synthetic datasets from a recipe.
positional arguments:
{generate,validate,schema,models}
generate Generate a dataset and write it to a directory.
validate Check a recipe without generating anything.
schema Print the recipe JSON schema on standard output.
models Manage third-party model components.
options:
-h, --help show this help message and exit
--version show program's version number and exit
sensym generate#
usage: sensym generate [-h] --out OUT
[--format {csv,tsv,json,jsonl,parquet,sqlite,sql,xlsx}]
[--dialect {postgres,mysql,sqlite,sqlserver,oracle}]
[--seed SEED] [--dirty] [--title TITLE]
[--author AUTHOR]
recipe
positional arguments:
recipe Path to a recipe in JSON.
options:
-h, --help show this help message and exit
--out OUT Directory to write the dataset into.
--format {csv,tsv,json,jsonl,parquet,sqlite,sql,xlsx}
Output format.
--dialect {postgres,mysql,sqlite,sqlserver,oracle}
Which SQL to write, for --format sql. Ignored by every
other format.
--seed SEED Override the recipe's seed for this run.
--dirty Publish the dirtied table rather than the clean one.
--title TITLE What to call the dataset in the citation block.
--author AUTHOR Who to credit in the citation block.
sensym validate#
usage: sensym validate [-h] recipe
positional arguments:
recipe Path to a recipe in JSON.
options:
-h, --help show this help message and exit
sensym schema#
usage: sensym schema [-h]
options:
-h, --help show this help message and exit
sensym models#
usage: sensym models [-h] [--manifest MANIFEST] [--cache-dir CACHE_DIR]
{list,install,verify,adopt,remove} ...
positional arguments:
{list,install,verify,adopt,remove}
list Show every component and its install state.
install Download and verify one or every component.
verify Re-checksum every component in the manifest.
adopt Register a copy already on disk as a component.
remove Delete an installed component.
options:
-h, --help show this help message and exit
--manifest MANIFEST Path to the model manifest TOML. Defaults to the
committed one.
--cache-dir CACHE_DIR
Where components are installed. Defaults to the OS
model cache.
sensym models list#
usage: sensym models list [-h] [--urls]
options:
-h, --help show this help message and exit
--urls Print URL and checksum instead of state, for an offline install.
sensym models install#
usage: sensym models install [-h] [--all] [id]
positional arguments:
id Component id to install.
options:
-h, --help show this help message and exit
--all Install every component.
sensym models verify#
usage: sensym models verify [-h]
options:
-h, --help show this help message and exit
sensym models adopt#
usage: sensym models adopt [-h] --path PATH id
positional arguments:
id Component id being adopted.
options:
-h, --help show this help message and exit
--path PATH Path to the already-downloaded file.
sensym models remove#
usage: sensym models remove [-h] id
positional arguments:
id Component id to remove.
options:
-h, --help show this help message and exit