core.components.runner

Copyright (c) Meta, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Classes

Runner	Represents an abstraction over things that run in a loop and can save/load state.
MockRunner	Used for testing

Module Contents

class core.components.runner.Runner

Represents an abstraction over things that run in a loop and can save/load state.

ie: Trainers, Validators, Relaxation all fall in this category.

Note

When running with the fairchemv2 cli, the job_config and attribute is set at runtime to those given in the config file.

job_config

a managed attribute that gives access to the job config

Type:

DictConfig

job_config

abstract run() → Any

abstract save_state(checkpoint_location: str, is_preemption: bool = False) → bool

abstract load_state(checkpoint_location: str | None) → None

class core.components.runner.MockRunner(x: int, y: int, z: int)

Bases: Runner

Used for testing

x

y

z

run() → Any

save_state(checkpoint_location: str, is_preemption: bool = False) → bool

load_state(checkpoint_location: str | None) → None