Merge pull request #122 from saleml/sphinx

Sphinx
GFNOrg · Aug 3, 2023 · 24633d0 · 24633d0
2 parents d2e6ddd + 61934bd
commit 24633d0
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -199,4 +199,4 @@ Currently, the implemented losses are:
 - Log Partition Variance loss. Introduced [here](https://arxiv.org/abs/2302.05446)
 
 # Scripts
-Example scripts are provided [here](https://github.com/saleml/torchgfn/tree/master/tutorials/scripts/). They can be used to reproduce published results in the HyperGrid environment, and the Box environment.
+Example scripts are provided [here](https://github.com/saleml/torchgfn/tree/master/tutorials/examples/). They can be used to reproduce published results in the HyperGrid environment, and the Box environment.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,8 +9,8 @@
 import sys
 
 project = "torchgfn"
-copyright = "2022, Salem Lahlou"
-author = "Salem Lahlou"
+copyright = "2022-2023, Salem Lahlou, Joseph Viviano, & Victor Schmidt"
+author = "Salem Lahlou, Joseph Viviano, & Victor Schmidt"
 
 
 sys.path.insert(0, os.path.abspath("../.."))
@@ -27,8 +27,15 @@
     "autoapi.extension",
     "sphinx.ext.napoleon",
 ]
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "restructuredtext",
+    ".md": "markdown",
+}
+
 autoapi_type = "python"
-autoapi_dirs = ["../../src/gfn"]
+autoapi_dirs = ["../../src/gfn", "../../tutorials"]
 autoapi_member_order = "alphabetical"
 
 autodoc_typehints = "description"

diff --git a/tutorials/README.md b/tutorials/README.md
@@ -1,5 +1,5 @@
 # Welcome to the `torchgfn` tutorials
 
 1. Learn the building blocks of your GflowNet with [notebooks](https://github.com/saleml/torchgfn/tree/master/tutorials/notebooks/)
-2. See `torchgfn` in action with example [training scripts](https://github.com/saleml/torchgfn/tree/master/tutorials/scripts/)
+2. See `torchgfn` in action with example [training scripts](https://github.com/saleml/torchgfn/tree/master/tutorials/examples/)
 3. Read a summary of what you need to do to create your own [Environment](https://github.com/saleml/torchgfn/tree/master/tutorials/ENV.md)
diff --git a/tutorials/scripts/README.md → tutorials/examples/README.md b/tutorials/scripts/README.md → tutorials/examples/README.md
diff --git a/tutorials/scripts/__init__.py → tutorials/examples/__init__.py b/tutorials/scripts/__init__.py → tutorials/examples/__init__.py
diff --git a/tutorials/scripts/train_box.py → tutorials/examples/train_box.py b/tutorials/scripts/train_box.py → tutorials/examples/train_box.py
@@ -1,4 +1,4 @@
-"""
+r"""
 The goal of this script is to reproduce some of the published results on the Box
 environment. Run one of the following commands to reproduce some of the results in
 [A theory of continuous generative flow networks](https://arxiv.org/abs/2301.12594)

diff --git a/tutorials/scripts/train_discreteebm.py → tutorials/examples/train_discreteebm.py b/tutorials/scripts/train_discreteebm.py → tutorials/examples/train_discreteebm.py
@@ -1,4 +1,4 @@
-"""
+r"""
 The goal of this script is to reproduce some of the published results on the HyperGrid
 environment. Run one of the following commands to reproduce some of the results in
 [Trajectory balance: Improved credit assignment in GFlowNets](https://arxiv.org/abs/2201.13259)

diff --git a/tutorials/scripts/train_hypergrid.py → tutorials/examples/train_hypergrid.py b/tutorials/scripts/train_hypergrid.py → tutorials/examples/train_hypergrid.py
@@ -1,4 +1,4 @@
-"""
+r"""
 The goal of this script is to reproduce some of the published results on the HyperGrid
 environment. Run one of the following commands to reproduce some of the results in
 [Trajectory balance: Improved credit assignment in GFlowNets](https://arxiv.org/abs/2201.13259)