Config Tools API¶
Configuration display tools.
Display the training configuration a run would use: the file, validated over the defaults.
load_config(config_path='./conf/config.yaml')
¶
Load main configuration file.
show_current_config(config_path='./conf/config.yaml')
¶
Display the training configuration a run would use.
The file is validated as Config over the defaults, so every value shown is one a run reads,
and a file that sets a key the configuration no longer has is refused, not shown (spec 4.5).
The working directory's gitignored conf/local.yaml then applies, as train applies it,
and the manifest it sets is marked as coming from there.
The panel lists the run's name, seed and inputs, then the settings every run records
(run_settings, P21), with the configured accelerator and the precision rule (P31).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config_path
|
Union[str, Path]
|
Path to main configuration file |
'./conf/config.yaml'
|
Returns:
| Type | Description |
|---|---|
bool
|
True when the configuration was displayed. False when an error was printed instead: the |
bool
|
file is missing, |
bool
|
then exits 1. |