Add docs header (#174)

vwxyzjn · web-flow · commit 9b002a05efb0 · 2022-04-26T10:46:58.000-04:00
* Add docs header

* Fix pre-commit

* Quick fix

* quick fix
diff --git a/cleanrl/c51.py b/cleanrl/c51.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/c51/#c51py
 import argparse
 import os
 import random
diff --git a/cleanrl/c51_atari.py b/cleanrl/c51_atari.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/c51/#c51_ataripy
 import argparse
 import os
 import random
diff --git a/cleanrl/ddpg_continuous_action.py b/cleanrl/ddpg_continuous_action.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ddpg/#ddpg_continuous_actionpy
 # docs and experiment results can be found at
 # https://docs.cleanrl.dev/rl-algorithms/ddpg/#ddpg_continuous_actionpy
 
diff --git a/cleanrl/dqn.py b/cleanrl/dqn.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/dqn/#dqnpy
 import argparse
 import os
 import random
diff --git a/cleanrl/dqn_atari.py b/cleanrl/dqn_atari.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/dqn/#dqn_ataripy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo.py b/cleanrl/ppo.py
@@ -1,5 +1,4 @@
-# docs and experiment results can be found at
-# https://docs.cleanrl.dev/rl-algorithms/ppo/#ppopy
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppopy
 
 import argparse
 import os
diff --git a/cleanrl/ppo_atari.py b/cleanrl/ppo_atari.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_ataripy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo_atari_envpool.py b/cleanrl/ppo_atari_envpool.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_atari_envpoolpy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo_atari_lstm.py b/cleanrl/ppo_atari_lstm.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_atari_lstmpy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo_continuous_action.py b/cleanrl/ppo_continuous_action.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_continuous_actionpy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo_pettingzoo.py b/cleanrl/ppo_pettingzoo.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_pettingzoopy
 import argparse
 import os
 import random
diff --git a/cleanrl/ppo_procgen.py b/cleanrl/ppo_procgen.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ppo/#ppo_procgenpy
 import argparse
 import os
 import random
diff --git a/cleanrl/sac_continuous_action.py b/cleanrl/sac_continuous_action.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/sac/#sac_continuous_actionpy
 import argparse
 import os
 import random
diff --git a/cleanrl/td3_continuous_action.py b/cleanrl/td3_continuous_action.py
@@ -1,3 +1,4 @@
+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/td3/#td3_continuous_actionpy
 import argparse
 import os
 import random
diff --git a/cleanrl_utils/add_header.py b/cleanrl_utils/add_header.py
@@ -0,0 +1,28 @@
+import os
+
+
+def add_header(dirname: str):
+    """
+    Add a header string with documentation link
+    to each file in the directory `dirname`.
+    """
+
+    for filename in os.listdir(dirname):
+        if filename.endswith(".py"):
+            with open(os.path.join(dirname, filename)) as f:
+                lines = f.readlines()
+
+            # hacky bit
+            exp_name = filename.split(".")[0]
+            algo_name = exp_name.split("_")[0]
+            header_string = f"# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/{algo_name}/#{exp_name}py"
+
+            if not lines[0].startswith(header_string):
+                print(f"adding headers for {filename}")
+                lines.insert(0, header_string + "\n")
+                with open(os.path.join(dirname, filename), "w") as f:
+                    f.writelines(lines)
+
+
+if __name__ == "__main__":
+    add_header("cleanrl")

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/c51/#c51py`
`1`	`2`	`import argparse`
`2`	`3`	`import os`
`3`	`4`	`import random`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/ddpg/#ddpg_continuous_actionpy`
`1`	`2`	`# docs and experiment results can be found at`
`2`	`3`	`# https://docs.cleanrl.dev/rl-algorithms/ddpg/#ddpg_continuous_actionpy`
`3`	`4`