from_config

from_config(conf, *, relative_path=True)

Load ComparerCollection from a config file (or dict)

Parameters

Name	Type	Description	Default
conf	Union[str, Path, dict]	path to config file or dict with configuration	required
relative_path		True: file paths are relative to configuration file, False: file paths are absolute (relative to the current directory), by default True	True

Returns

Name	Type	Description
	ComparerCollection	A ComparerCollection object from the given configuration

Examples

>>> import modelskill as ms
>>> cc = ms.from_config('../data/conf.yml')
>>> cc

<ComparerCollection>
Comparers:
0: Klagshamn - Water Level [m]
1: Drogden - Water Level [m]