You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current documentation requires more work. First, some of the implemented algorithms such as Apex-DQN, TD3, and SAC are not documented at https://docs.cleanrl.dev. Second, even the documented algorithm such as PPO does not have complete documentation: for example, the ppo_atari_envpool.py is not really documented. Third, there doesn't seem to be a single-source place to put documentation.
Going forward, I'd like to impose a specific documentation style and improve the overall workflow, which will also help #117.
Proposed solution
I was thinking maybe we can put a documentation link at the beginning of each file. For example, we could add these two lines at ppo.py.
What is the problem
The current documentation requires more work. First, some of the implemented algorithms such as Apex-DQN, TD3, and SAC are not documented at https://docs.cleanrl.dev. Second, even the documented algorithm such as PPO does not have complete documentation: for example, the
ppo_atari_envpool.py
is not really documented. Third, there doesn't seem to be a single-source place to put documentation.Going forward, I'd like to impose a specific documentation style and improve the overall workflow, which will also help #117.
Proposed solution
I was thinking maybe we can put a documentation link at the beginning of each file. For example, we could add these two lines at
ppo.py
.https://github.com/vwxyzjn/cleanrl/blob/c8faef93fc8dbc9528183840ab75b8962df7b9c4/cleanrl/ppo.py#L1-L7
And this link of https://cleanrl-553u0zazz-vwxyzjn.vercel.app/rl-algorithms/ppo/#ppopy will point to the corresponding documentation that has
ppo.py
specifically doesWhich roughly looks like below (haven't added the tracked experiments)
ppodemo.mp4
List of files needed to add documentation
ppo.py
documentation #120apex_dqn_atari.py
#136ddpg_continuous_action.py
docs #137dqn_atari.py
documentation #124td3_continuous_action.py
#141dqn.py
#157c51.py
andc51_atari.py
#159The text was updated successfully, but these errors were encountered: