Back to Datasets

Command Line Interface (CLI)

docs/source/cli.mdx

4.8.41.4 KB
Original Source

Command Line Interface (CLI)

šŸ¤— Datasets provides a command line interface (CLI) with useful shell commands to interact with your dataset.

You can check the available commands:

bash
>>> datasets-cli --help
usage: datasets-cli <command> [<args>]

positional arguments:
  {env,test,delete_from_hub}
                        datasets-cli command helpers
    env                 Print relevant system environment info.
    test                Test dataset loading.
    delete_from_hub     Delete dataset config from the Hub

optional arguments:
  -h, --help            show this help message and exit

Delete from Hub

Delete a dataset configuration from a supported dataset on the Hub.

bash
>>> datasets-cli delete_from_hub --help
usage: datasets-cli <command> [<args>] delete_from_hub [-h] [--token TOKEN] [--revision REVISION] dataset_id config_name

positional arguments:
  dataset_id           source dataset ID, e.g. USERNAME/DATASET_NAME or ORGANIZATION/DATASET_NAME
  config_name          config name to delete

optional arguments:
  -h, --help           show this help message and exit
  --token TOKEN        access token to the Hugging Face Hub
  --revision REVISION  source revision

For example:

bash
>>> datasets-cli delete_from_hub USERNAME/DATASET_NAME CONFIG_NAME

[!TIP] Do not forget that you need to log in first to your Hugging Face account:

bash
>>> hf auth login