monad.ui.fit_behavioral_representation

monad.ui.fit_behavioral_representation(config_path, output_path, storage_config_path=None, nan_threshold=0.9, resume=False, overwrite=False, seed=None)

Analyzes the data and builds the feature representation needed for model training.

from monad.ui import fit_behavioral_representation
from pathlib import Path

fit_behavioral_representation(
    config_path=Path("path/to/config.yaml"),
    output_path=Path("path/to/store/pretrain/artifacts")
)

config_path : pathlib.Path
Path to YAML configuration file.

output_path : pathlib.Path
Path to store training results.

storage_config_path : [Optional[pathlib.Path]
Default: None
File system configuration.

resume : bool
Default: False
If True, training will be resumed from the last checkpoint if such exists, an error will be thrown otherwise.

overwrite : bool
Default: False
If True, any previous training results will be overwritten. Otherwise, if resume is not set and checkpoints from previous training are present, error will be raised.

❗️

Note

The parameters resume and overwrite cannot both be set to True. Doing so will raise an error.

nan_threshold : float
Default: 0.9
Maximum fraction of missing values allowed in a column to process.

seed: Optional[int]
_Default: None
Seed for the training, when provided, ensures reproducibility of the results.

Saves results under output_path.