rxn.onmt_models.scripts.rxn_plan_training.Parameter

class rxn.onmt_models.scripts.rxn_plan_training.Parameter(key, query, default, commands, optional=True)[source]

Bases: object

Parameter to be queried to the user, if the command(s) are necessary.

Parameters

  • key (str) –

  • query (str) –

  • default (Union[int, float]) –

  • commands (RxnCommand) –

  • optional (bool, default: True) –

__init__(key, query, default, commands, optional=True)[source]
Parameters

  • key (str) – parameter name as it is forwarded to the scripts. `

  • query (str) – string displayed to the user when querying.

  • default (Union[int, float]) – default value for this parameter.

  • commands (RxnCommand) – command(s) that this parameter is needed for.

  • optional (bool, default: True) – if a parameter is optional and its queried value is equal to the default, it will not be displayed to the user in the command(s) to execute.

Methods

__init__(key, query, default, commands[, ...])

type key

str