mloq.commands.setup#

Mloq setup command implementation.

Module Contents#

Classes#

SetupCMD

Implement the functionality of the setup Command.

Functions#

_sub_commands()

Attributes#

SUB_COMMANDS

mloq.commands.setup._sub_commands()[source]#
mloq.commands.setup.SUB_COMMANDS#
class mloq.commands.setup.SetupCMD(record, interactive=False)[source]#

Bases: mloq.command.CommandMixin

Implement the functionality of the setup Command.

Parameters
cmd_name = setup#
files#
SUB_COMMAND_CLASSES#
property config#

List of all the commands that will be executed when running mloq setup.

Return type

omegaconf.DictConfig

property sub_commands#

List of all the commands that will be executed when running mloq setup.

Return type

List[mloq.command.Command]

property directories#

Tuple containing Paths objects representing the directories created by the command.

Return type

Tuple[pathlib.Path]

interactive_config()[source]#

Generate the configuration of the project interactively.

Return type

omegaconf.DictConfig

parse_config()[source]#

Update the configuration DictConfig with the Command parameters.

Return type

omegaconf.DictConfig

run_side_effects()[source]#

Apply additional configuration methods.

Return type

None

record_files()[source]#

Register the files that will be generated by mloq.

Return type

None