carate.cli package

Submodules

carate.cli.automate module

Module providing a CLI interface for training models#

author:

Julian M. Kleber

carate.cli.automate.start_run(c: str, d: str) → None[source]

The train_algorithm function takes in a config file and an output directory. It then runs the algorithm using the configuration specified in the config file, and saves all of its outputs to the output directory.

Parameters:

  • c:str – Used to specify the path to the configuration file.

  • d:str – Used to specify the path to the configuration file.

Returns:

None.

Doc-author:

Julian M. Kleber

carate.cli.automate.train_whole_directory(d: str) → None[source]

The train_algorithm function takes in a config file and an output directory. It then runs the algorithm using the configuration specified in the config file, and saves all of its outputs to the output directory.

Parameters:

  • c:str – Used to specify the directory to the configuration files.

  • o:str – Used to specify the output directory.

Returns:

None.

Doc-author:

Julian M. Kleber

Module contents