dymad.training.phases¶

Functions

`build_phase`(spec, *, config, model_class, ...)
`normalize_phase_specs`(config)

Classes

`AnalysisPhaseSpec`(name, *[, split, ...])
`BaseOptimizerPhase`(*, spec, config, ...)
`BasePhase`(*, spec, config, model_class, ...)
`BasePhaseSpec`(name, kind[, config])
`BestModelExportPhase`(*, spec, config, ...)
`ContextDataPhase`(*, spec, config, ...)
`DataPhaseSpec`(name, *[, operation, config])
`ExportPhaseSpec`(name, *, export_kind[, config])
`LinearRegressionPhase`(*, spec, config, ...)
`LinearSolvePhase`(*, spec, config, ...)
`LinearSolvePhaseSpec`(name, *, method[, ...])
`NodeOptimizerPhase`(*, spec, config, ...)
`OneStepOptimizerPhase`(*, spec, config, ...)
`OptimizerPhaseSpec`(name, trainer, config, *)
`RunCheckpointExportPhase`(*, spec, config, ...)
`SummaryExportPhase`(*, spec, config, ...)
`ValidationAnalysisPhase`(*, spec, config, ...)
`WeakFormOptimizerPhase`(*, spec, config, ...)

Exceptions

PhaseSpecValidationError

Raised when a phase spec or normalized legacy config is invalid.

class dymad.training.phases.AnalysisPhaseSpec(name, *, split='valid', evaluate_all=False, config=None)¶

Bases: BasePhaseSpec

config: dict[str, Any]¶

evaluate_all: bool = False¶

kind: str¶

name: str¶

split: str = 'valid'¶

class dymad.training.phases.BaseOptimizerPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.BasePhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: object

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

replay_context(*, phase_context, artifacts, logger)¶

Return type:: tuple[PhaseContext, ArtifactRegistry]

class dymad.training.phases.BasePhaseSpec(name, kind, config=<factory>)¶

Bases: object

config: dict[str, Any]¶

kind: str¶

name: str¶

class dymad.training.phases.BestModelExportPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.ContextDataPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

replay_context(*, phase_context, artifacts, logger)¶

Return type:: tuple[PhaseContext, ArtifactRegistry]

class dymad.training.phases.DataPhaseSpec(name, *, operation='context', config=None)¶

Bases: BasePhaseSpec

config: dict[str, Any]¶

kind: str¶

name: str¶

operation: str = 'context'¶

class dymad.training.phases.ExportPhaseSpec(name, *, export_kind, config=None)¶

Bases: BasePhaseSpec

config: dict[str, Any]¶

export_kind: str = 'best_model'¶

kind: str¶

name: str¶

class dymad.training.phases.LinearRegressionPhase(*, spec, config, model_class, dtype, execution_services)¶: Bases: BaseOptimizerPhase

class dymad.training.phases.LinearSolvePhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.LinearSolvePhaseSpec(name, *, method, params=None, kwargs=None, reset_optimizer=True, config=None)¶

Bases: BasePhaseSpec

config: dict[str, Any]¶

kind: str¶

kwargs: dict[str, Any]¶

method: str = 'full'¶

name: str¶

params: Any = None¶

reset_optimizer: bool = True¶

class dymad.training.phases.NodeOptimizerPhase(*, spec, config, model_class, dtype, execution_services)¶: Bases: BaseOptimizerPhase

class dymad.training.phases.OneStepOptimizerPhase(*, spec, config, model_class, dtype, execution_services)¶: Bases: BaseOptimizerPhase

class dymad.training.phases.OptimizerPhaseSpec(name, trainer, config, *, reset_optimizer=False)¶

Bases: BasePhaseSpec

config: dict[str, Any]¶

kind: str¶

name: str¶

reset_optimizer: bool = False¶

trainer: str = 'NODE'¶

exception dymad.training.phases.PhaseSpecValidationError¶

Bases: ValueError

Raised when a phase spec or normalized legacy config is invalid.

class dymad.training.phases.RunCheckpointExportPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.SummaryExportPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.ValidationAnalysisPhase(*, spec, config, model_class, dtype, execution_services)¶

Bases: BasePhase

execute(*, trainer_state, phase_context, artifacts, run_name, logger)¶

Return type:: PhaseResult

class dymad.training.phases.WeakFormOptimizerPhase(*, spec, config, model_class, dtype, execution_services)¶: Bases: BaseOptimizerPhase

dymad.training.phases.build_phase(spec, *, config, model_class, dtype, execution_services)¶

Return type:: BasePhase

dymad.training.phases.normalize_phase_specs(config)¶

Return type:: list[OptimizerPhaseSpec | LinearSolvePhaseSpec | DataPhaseSpec | AnalysisPhaseSpec | ExportPhaseSpec]