autointent.configs.LoggingConfig

class autointent.configs.LoggingConfig(/, **data)

Bases: pydantic.BaseModel

Configuration for the logging.

Parameters:

data (Any)

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_dir: pathlib.Path | str | None = None

Path to the directory with different runs.

run_name: str | None = None

Name of the run. If None, a random name will be generated. To get run_name better use autointent.configs.LoggingConfig.get_run_name().

dump_modules: bool = None

Whether to dump the modules or not

clear_ram: bool = None

Whether to clear the RAM after dumping the modules

report_to: list[autointent._callbacks.REPORTERS_NAMES] | None = None

List of callbacks to report to. If None, no callbacks will be used

property dirpath: pathlib.Path

Path to the directory where the logs will be saved.

Return type:

pathlib.Path

property dump_dir: pathlib.Path

Path to the directory where the modules will be dumped.

Return type:

pathlib.Path

get_run_name()

Return name of the run.

Use this method instead of direct adressing to autointent.configs.LoggingConfig.run_name.

Return type:

str