noether.core.factory.schedule

Classes

ScheduleFactory

Factory for creating schedules. Handles wrapping into ScheduleWrapper which handles update/epoch based

Module Contents

class noether.core.factory.schedule.ScheduleFactory(returns_partials=False)

Bases: noether.core.factory.base.Factory

Factory for creating schedules. Handles wrapping into ScheduleWrapper which handles update/epoch based scheduling. Additionally, populates the effective_batch_size and updates_per_epoch to avoid specifying it in the config.

Parameters:

returns_partials (bool)

create(schedule_config, **kwargs)

Creates a schedule based on the provided config and wraps it into a ScheduleWrapper.

Parameters:

• schedule_config (noether.core.schemas.schedules.AnyScheduleConfig) – The schedule config or already instantiated schedule. See AnyScheduleConfig for available options.

• **kwargs – Additional keyword arguments that are passed to the schedule constructor.

Returns:

The instantiated schedule wrapped in ScheduleWrapper.

Return type:

noether.core.utils.training.ScheduleWrapper | None