noether.core.schemas.trackers

Attributes

AnyTracker

Classes

BaseTrackerConfig	Base configuration for experiment trackers. All tracker configs should inherit from this class.
WandBTrackerSchema	Base configuration for experiment trackers. All tracker configs should inherit from this class.
TrackioTrackerSchema	Schema for TrackioTracker configuration.
TensorboardTrackerSchema	Schema for TensorboardTracker configuration.

Module Contents

class noether.core.schemas.trackers.BaseTrackerConfig(/, **data)

Bases: noether.core.schemas.lib._RegistryBase

Base configuration for experiment trackers. All tracker configs should inherit from this class.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

kind: str | None = None

class noether.core.schemas.trackers.WandBTrackerSchema(/, **data)

Bases: BaseTrackerConfig

Base configuration for experiment trackers. All tracker configs should inherit from this class.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

entity: str | None = None

The entity name for the W&B project.

project: str | None = None

The project name for the W&B project.

mode: Literal['disabled', 'online', 'offline'] | None = None

Tracking mode. Can be ‘disabled’, ‘online’, or ‘offline’.

class noether.core.schemas.trackers.TrackioTrackerSchema(/, **data)

Bases: BaseTrackerConfig

Schema for TrackioTracker configuration.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

project: str

The project name for the Trackio project.

space_id: str | None = None

The HuggingFace space ID where to store the Trackio data.

class noether.core.schemas.trackers.TensorboardTrackerSchema(/, **data)

Bases: BaseTrackerConfig

Schema for TensorboardTracker configuration.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

log_dir: str = None

The base directory where TensorBoard event files will be stored.

flush_secs: int = None

How often, in seconds, to flush the pending events to disk.

noether.core.schemas.trackers.AnyTracker