dump_project_config_yaml#
- scikitplot.mlflow.dump_project_config_yaml(cfg=None, path=None, *, profile='local', source_config_path=None)[source]#
Write a ProjectConfig to a YAML file.
This function supports two strict modes:
Explicit mode (library-level):
dump_project_config_yaml(cfg, path)Project convenience mode (newbie-friendly):
dump_project_config_yaml(profile="local")- Loads config from<project_root>/configs/mlflow.tomlby default - Writes YAML to<project_root>/configs/mlflow.yamlby default
- Parameters:
- cfgProjectConfig or None, default=None
Configuration to write. If None,
source_config_path(or default project TOML) is loaded and used.- pathpathlib.Path or None, default=None
Output YAML file path. If None in convenience mode, uses the default project YAML path.
- profilestr, default=”local”
Profile name used when loading the source configuration in convenience mode.
- source_config_pathpathlib.Path or None, default=None
Source config path to load in convenience mode. If None, defaults to
<project_root>/configs/mlflow.toml.
- Returns:
- pathlib.Path
The YAML path written.
- Raises:
- ImportError
If PyYAML is not installed.
- FileNotFoundError
If convenience mode cannot find a source config.
- ValueError
If arguments are inconsistent (e.g., cfg provided but path missing).
- Parameters:
cfg (ProjectConfig | None)
path (Path | None)
profile (str)
source_config_path (Path | None)
- Return type:
