Skip to content

ModelParser

class ModelParser(config_path: str | pathlib.Path)

ModelParser reads a given YAML configuration file (see configuration guide) and parses the contents into a ModelConfig object.

Parameters:

Name Type Description
config_path str | pathlib.Path Path to the YAML config file.
config ModelConfig Parsed config object.

 

Methods:

Signature Return Type Description
.from_yaml() ModelConfig Reads the file and populates ModelParser.config. Runs at __init__.
.get() ModelConfig Returns the currently parsed model config.
.to_pickle(filepath: str | pathlib.Path) None Serializes the current ModelConfig and saves to filepath.