Working with the CLI

The Noether CLI provides a convenient way of performing high-level actions.

Some of the Python modules exposes unique functionality and therefore its own set of commands.

A global --debug flag enables extended debug logging, useful for narrowing down issues, for example:

noether-data --debug aws estimate ...

In this documentation we will be using CLI for noether.io module.

Important

Whenever you use a CLI from the Noether framework - your data stays on your local machine!

Emmi AI doesn’t store or collect your data.

Credential Setup

To communicate with services, you must configure credentials:

  1. Create a file under your profile root, e.g. /users/username/.config/emmi/config.json.

  2. Populate the file (replace empty strings with your values; unused services may stay empty):

{
    "huggingface": {
        "HF_TOKEN": ""
    },
    "aws": {
        "AWS_ACCESS_KEY_ID": "",
        "AWS_SECRET_ACCESS_KEY": "",
        "AWS_SESSION_TOKEN": "",
        "AWS_REGION": "",
        "AWS_DEFAULT_REGION": ""
    }
}

Note

For AWS the values AWS_SESSION_TOKEN, AWS_REGION, and AWS_DEFAULT_REGION are optional. In case when AWS_ACCESS_KEY_ID starts with ASIA... the AWS_SESSION_TOKEN needs to be provided.

Testing the Credentials

Verify your setup by running the estimate command, which fetches metadata and reports the estimated size:

Hugging Face:

noether-data huggingface estimate EmmiAI/AB-UPT

AWS:

noether-data aws estimate noaa-goes16 ABI-L1b-RadC/2023/001/00/

If you see no errors — congratulations, your setup works!

Scaffolding a New Project

The noether-init command scaffolds a minimal Noether training project, including all required modules and configurations.

uv run noether-init my_project

Required:

  • project_name (positional) — project name, must be a valid Python identifier

Optional:

  • --tracker, -t — experiment tracker: disabled (default), wandb, trackio, tensorboard

  • --hardware — hardware target: gpu (default), mps, cpu

  • --project-dir, -d — parent directory for the project folder

  • --wandb-entity — W&B entity name (only used with --tracker wandb)

For all available options, see Scaffolding a New Project.