teachcompute.args

get_parsed_args

teachcompute.args.get_parsed_args(name: str, scenarios: Dict[str, str] | None = None, description: str | None = None, epilog: str | None = None, number: int = 10, repeat: int = 10, warmup: int = 5, sleep: float = 0.1, tries: int = 2, expose: str | None = None, args: List[str] | None = None, **kwargs: Dict[str, Tuple[int | str | float, str]]) → Namespace

Returns parsed arguments for examples in this package.

Paramètres:

• name – script name

• scenarios – list of available scenarios

• description – parser description

• epilog – text at the end of the parser

• number – default value for number parameter

• repeat – default value for repeat parameter

• warmup – default value for warmup parameter

• sleep – default value for sleep parameter

• expose – if empty, keeps all the parameters, if None, only publish kwargs contains, otherwise the list of parameters to publish separated by a comma

• args – or sys.args if empty

• kwargs – additional parameters, example: n_trees=(10, « number of trees to train »)

Renvoie:

parser