Skip to content

declearn.quickrun.ModelConfig

Bases: TomlConfig

Dataclass used to provide custom model location and name.

Attributes:

Name Type Description
model_file str or None

Path to the python file under which the model is declared. If None, look for "model.py" parallel to the "config.toml" one.
model_name str, default="model"

Name of the variable storing the declearn Model to train, declared in the main scope of the model file.
Source code in declearn/quickrun/_config.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@dataclasses.dataclass
class ModelConfig(TomlConfig):
    """Dataclass used to provide custom model location and name.

    Attributes
    ----------
    model_file: str or None
        Path to the python file under which the model is declared.
        If None, look for "model.py" parallel to the "config.toml" one.
    model_name: str, default="model"
        Name of the variable storing the declearn Model to train,
        declared in the main scope of the model file.
    """

    model_file: Optional[str] = None
    model_name: str = "model"