noether.scaffold.config

Attributes

TEMPLATES

Classes

ScaffoldConfig

Functions

substitute(content, config)	Replace template placeholders with config values.
resolve_config(project_name, tracker, hardware, ...)	Build a fully-resolved ScaffoldConfig.

Module Contents

noether.scaffold.config.TEMPLATES

class noether.scaffold.config.ScaffoldConfig

project_name: str

tracker: noether.scaffold.choices.TrackerChoice

hardware: noether.scaffold.choices.HardwareChoice

project_dir: pathlib.Path

wandb_entity: str | None

noether.scaffold.config.substitute(content, config)

Replace template placeholders with config values.

Parameters:

• content (str)

• config (ScaffoldConfig)

Return type:

str

noether.scaffold.config.resolve_config(project_name, tracker, hardware, project_dir, wandb_entity)

Build a fully-resolved ScaffoldConfig.

Parameters:

• project_name (str)

• tracker (noether.scaffold.choices.TrackerChoice)

• hardware (noether.scaffold.choices.HardwareChoice)

• project_dir (pathlib.Path)

• wandb_entity (str | None)

Return type:

ScaffoldConfig