noether.scaffold.cli

Attributes

app

Functions

main(project_name[, tracker, hardware, project_dir, ...])

Scaffold a new Noether training project.

Module Contents

noether.scaffold.cli.app
noether.scaffold.cli.main(project_name, tracker=TrackerChoice.DISABLED, hardware=HardwareChoice.GPU, project_dir=Path('.'), wandb_entity=None)

Scaffold a new Noether training project.

Parameters:

  • project_name (Annotated[str, typer.Argument(help="Project name (valid Python identifier). Examples: 'my_project', 'MyProject1'). No hyphens allowed.")])

  • tracker (Annotated[noether.scaffold.choices.TrackerChoice, typer.Option('--tracker', '-t', help='Experiment tracker')])

  • hardware (Annotated[noether.scaffold.choices.HardwareChoice, typer.Option('--hardware', help='Hardware target')])

  • project_dir (Annotated[pathlib.Path, typer.Option('--project-dir', '-d', help='Where to create project dir')])

  • wandb_entity (Annotated[str | None, typer.Option('--wandb-entity', help="W&B entity, e.g. 'my-team' (defaults to your W&B username)")])

Return type:

None