Some methods or functions have no docstrings, so we have to write.
Contributors who write the codes should write the docstrings of those by themselves.
For now, @takerfume @jinbeizame007 @iory @ven-kyoshiro should write docstrings.
We can find which codes lack docstrings by error messages described below.
The following error message appears when build html files.
We can add docstrings by the following 2 steps.
write docstrings in the codes.
add build html files and send a pull request by following this explanation.
WARNING: autodoc: failed to import module 'airl' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.airl'
WARNING: autodoc: failed to import module 'behavior_clone' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.behavior_clone'
WARNING: autodoc: failed to import module 'diayn' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.diayn'
WARNING: autodoc: failed to import module 'diayn_sac' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.diayn_sac'
WARNING: autodoc: failed to import module 'gail' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.gail'
WARNING: autodoc: failed to import module 'mpc' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.mpc'
WARNING: autodoc: failed to import module 'on_pol_teacher_distill' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.on_pol_teacher_distill'
WARNING: autodoc: failed to import module 'prioritized_ddpg' from module 'machina.algos'; the following exception was raised:
No module named 'machina.misc'
WARNING: autodoc: failed to import module 'r2d2_sac' from module 'machina.algos'; the following exception was raised:
No module named 'machina.algos.r2d2_sac'
WARNING: autodoc: failed to import module 'ac_in_ob_env' from module 'machina.envs'; the following exception was raised:
No module named 'machina.envs.ac_in_ob_env'
WARNING: autodoc: failed to import module 'env_utils' from module 'machina.envs'; the following exception was raised:
No module named 'machina.envs.env_utils'
WARNING: autodoc: failed to import module 'rew_in_ob_env' from module 'machina.envs'; the following exception was raised:
No module named 'machina.envs.rew_in_ob_env'
WARNING: autodoc: failed to import module 'skill_env' from module 'machina.envs'; the following exception was raised:
No module named 'machina.envs.skill_env'
WARNING: autodoc: failed to import module 'models' from module 'machina'; the following exception was raised:
No module named 'machina.models'
WARNING: autodoc: failed to import module 'models.base' from module 'machina'; the following exception was raised:
No module named 'machina.models'
WARNING: autodoc: failed to import module 'models.deterministic_state_model' from module 'machina'; the following exception was raised:
No module named 'machina.models'
WARNING: autodoc: failed to import module 'distributed_sgd' from module 'machina.optims'; the following exception was raised:
No module named 'machina.optims.distributed_sgd'
WARNING: autodoc: failed to import module 'mpc_pol' from module 'machina.pols'; the following exception was raised:
No module named 'machina.pols.mpc_pol'
WARNING: autodoc: failed to import module 'random_pol' from module 'machina.pols'; the following exception was raised:
takerfume
commented
5 years ago
Some methods or functions have no docstrings, so we have to write. Contributors who write the codes should write the docstrings of those by themselves.
For now, @takerfume @jinbeizame007 @iory @ven-kyoshiro should write docstrings. We can find which codes lack docstrings by error messages described below. The following error message appears when build html files.
We can add docstrings by the following 2 steps.