tempor package

Subpackages

Module contents

Initialization of the tempor library.

tempor.get_config() → TemporConfig[source]

Get the current TemporAI configuration.

Returns:

TemporAI configuration.

Return type:

TemporConfig

tempor.configure(new_config: TemporConfig | DictConfig | str | Path) → TemporConfig[source]

Configure TemporAI with a new config.

Parameters:
new_config : Union[TemporConfig, omegaconf.DictConfig, str, pathlib.Path]

The new configuration. Can be a TemporConfig object, a DictConfig object, or a path to a YAML file.

Returns:

TemporAI configuration.

Return type:

TemporConfig

class tempor.TemporConfig(logging: LoggingConfig, working_directory: str = '???')[source]

Bases: object

The main configuration class for the TemporAI library.

logging : LoggingConfig

Logging configuration.

working_directory : str = '???'

Working directory for the library. Can be set to a path string, "$PWD". or "~".

get_working_dir() → str[source]

Get the working directory, with "$PWD" and "~" expanded.

Returns:

The working directory string.

Return type:

str