Open AI Gym
Petting Zoo
Stabe Baselines 3
Optuna
Ver. 0.0.0 (2021-mm-dd) This module provides …
- class mlpro.wrappers.optuna.Example(p_arg1, p_arg2=True)
Bases:
object
The __init__ method should be documented in the class level docstring and the docstring itself should not go beyond 100 characters length (within the dash separator). Sections inside the docstring can be seperated like the reStructuredText format.
Parameters are documented in the Parameters section. Public attributes of classes are documented inisde Attributes section. Returns attronites are documented in the Returns section.
A few examples of data types: int / str / bool / list of str / tuple of int / float / None / dict. If the parameters have default values, you should add “TYPE, optional” as part of the type and “The default is ….” as part of the description.
Notes
The content inside the section should be indented.
- Parameters
p_arg1 (TYPE) – explanation of the first parameter.
p_arg2 (TYPE, optional) – explanation of the second parameter. The default is True.
- attr1
explanation of the public attribute attr1.
- Type
TYPE
- attr1 = None
- example_method(p_arg1)
Example on how to document return type.
Notes
The name of the return value is required for better understanding of the code. The return value is parsed similarly as parameters value, meaning that multiple return value is also possible.
- Parameters
p_arg1 (TYPE) – explanation of the first parameter.
- Returns
p_arg1 – Description of the returned value.
- Return type
TYPE
- example_method_no_return(p_arg1)
Example on how to document return type.
Notes
When there is no item to be returned, the return section is omitted.
- Parameters
p_arg1 (TYPE) – explanation of the first parameter.