[Doc] minor improvements: move base NCO classes out

ai4co · Apr 30, 2024 · 97e90b9 · 97e90b9
1 parent 3c1c9da
commit 97e90b9
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 54 deletions.
diff --git a/docs/_content/api/models/common/__init__.md b/docs/_content/api/models/common/__init__.md
@@ -4,6 +4,7 @@
 We categorize NCO approaches (which are in fact not necessarily trained with RL!) into the following: 1) constructive, 2) improvement, 3) transductive.
 
 
+
 ```{eval-rst}
 .. tip::
    Note that in RL4CO we distinguish the RL algorithms and the actors via the following naming:
@@ -29,17 +30,17 @@ The following table contains the categorization that we follow in RL4CO:
      - Input
      - Output
      - Description
-   * - Constructive
+   * - `Constructive <constructive.md>`_
      - Policy
      - Instance
      - Solution
      - Policies trained to generate solutions from scratch. Can be categorized into AutoRegressive (AR) and Non-Autoregressive (NAR).
-   * - Improvement
+   * - `Improvement <improvement.md>`_
      - Policy
      - Instance, Current Solution
      - Improved Solution
      - Policies trained to improve existing solutions iteratively, akin to local search algorithms. They focus on refining *existing* solutions rather than generating them from scratch.
-   * - Transductive
+   * - `Transductive <transductive.md>`_
      - Model
      - Instance, (Policy)
      - Solution, (Updated Policy)

diff --git a/docs/_content/api/models/zoo/__init__.md b/docs/_content/api/models/zoo/__init__.md
@@ -0,0 +1,3 @@
+# Model Zoo
+
+Models from the literature and contributions are contained in the Model Zoo.
diff --git a/docs/_content/api/models/zoo.md → docs/_content/api/models/zoo/constructive.md b/docs/_content/api/models/zoo.md → docs/_content/api/models/zoo/constructive.md
@@ -1,9 +1,3 @@
-# Model Zoo
-
-Models from the literature and contributions are contained in the Model Zoo.
-
----
-
 # Constructive Methods
 
 These can be classified into Auto-Regressive (AR) and Non-Auto-Regressive (NAR) policies. These constructive methods also include ad-hoc RL algorithms for constructive policies.
@@ -218,47 +212,4 @@ These can be classified into Auto-Regressive (AR) and Non-Auto-Regressive (NAR)
 .. automodule:: rl4co.models.zoo.nargnn.encoder
    :members:
    :undoc-members:
-```
-
----
-
-# Improvement Methods
-
-These methods are trained to improve existing solutions iteratively, akin to local search algorithms. They focus on refining existing solutions rather than generating them from scratch.
-
-_coming soon!_
-
-
----
-
-# Transductive Methods
-
-These methods update policy parameters during online testing to improve the solutions of a specific instance.
-
-## Active Search (AS)
-
-```{eval-rst}
-.. automodule:: rl4co.models.zoo.active_search.search
-   :members:
-   :undoc-members:
-```
-
-## Efficent Active Search (EAS)
-
-```{eval-rst}
-.. automodule:: rl4co.models.zoo.eas.search
-   :members:
-   :undoc-members:
-```
-
-```{eval-rst}
-.. automodule:: rl4co.models.zoo.eas.decoder
-   :members:
-   :undoc-members:
-```
-
-```{eval-rst}
-.. automodule:: rl4co.models.zoo.eas.nn
-   :members:
-   :undoc-members:
 ```
diff --git a/docs/_content/api/models/zoo/improvement.md b/docs/_content/api/models/zoo/improvement.md
@@ -0,0 +1,5 @@
+# Improvement Methods
+
+These methods are trained to improve existing solutions iteratively, akin to local search algorithms. They focus on refining existing solutions rather than generating them from scratch.
+
+_coming soon!_
diff --git a/docs/_content/api/models/zoo/transductive.md b/docs/_content/api/models/zoo/transductive.md
@@ -0,0 +1,31 @@
+# Transductive Methods
+
+These methods update policy parameters during online testing to improve the solutions of a specific instance.
+
+## Active Search (AS)
+
+```{eval-rst}
+.. automodule:: rl4co.models.zoo.active_search.search
+   :members:
+   :undoc-members:
+```
+
+## Efficent Active Search (EAS)
+
+```{eval-rst}
+.. automodule:: rl4co.models.zoo.eas.search
+   :members:
+   :undoc-members:
+```
+
+```{eval-rst}
+.. automodule:: rl4co.models.zoo.eas.decoder
+   :members:
+   :undoc-members:
+```
+
+```{eval-rst}
+.. automodule:: rl4co.models.zoo.eas.nn
+   :members:
+   :undoc-members:
+```
diff --git a/docs/index.md b/docs/index.md
@@ -37,6 +37,7 @@ RL4CO is built upon:
    _content/start/installation
    _collections/1-quickstart
    _content/start/hydra
+   _content/api/models/common/__init__
 
 
 .. toctree::
@@ -80,7 +81,6 @@ RL4CO is built upon:
    :maxdepth: 3
    :caption: Base NCO Methods
 
-   _content/api/models/common/__init__
    _content/api/models/common/constructive
    _content/api/models/common/improvement
    _content/api/models/common/transductive
@@ -90,7 +90,10 @@ RL4CO is built upon:
    :maxdepth: 3
    :caption: Model Zoo
 
-   _content/api/models/zoo
+   _content/api/models/common/zoo/__init__
+   _content/api/models/common/zoo/constructive
+   _content/api/models/common/zoo/improvement
+   _content/api/models/common/zoo/transductive
 
 .. toctree::
    :maxdepth: 3
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Model Zoo

		Models from the literature and contributions are contained in the Model Zoo.