Deploy documentation to GitHub Pages

NVlabs · Feb 4, 2025 · 28eb08d · 28eb08d
commit 28eb08d
Show file tree

Hide file tree

Showing 87 changed files with 10,332 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/gbrl/ac_gbrl.html b/_modules/gbrl/ac_gbrl.html
diff --git a/_modules/gbrl/gbt.html b/_modules/gbrl/gbt.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,108 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; GBRL 1.0.11 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
+
+
+      <script src="../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../_static/documentation_options.js?v=9306f2a9"></script>
+      <script src="../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            GBRL
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Documentation:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../gbt.html">GBRL Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../actor_critic/index.html">Actor Critic Module</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">GBRL</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="gbrl/ac_gbrl.html">gbrl.ac_gbrl</a></li>
+<li><a href="gbrl/gbt.html">gbrl.gbt</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, NVIDIA Corporation.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/actor_critic/ActorCritic.rst.txt b/_sources/actor_critic/ActorCritic.rst.txt
@@ -0,0 +1,11 @@
+ActorCritic Class
+=================
+
+This class implements a GBT-based Actor-Critic learner for reinforcement learning.
+The ActorCritic class can be used with a shared-tree structure or a separate tree strucutre. 
+Usage examples: GBT-based PPO/AWR implementations.
+
+.. autoclass:: gbrl.ac_gbrl.ActorCritic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/actor_critic/ContinuousCritic.rst.txt b/_sources/actor_critic/ContinuousCritic.rst.txt
@@ -0,0 +1,11 @@
+ContinuousCritic Class
+======================
+
+This class implements a GBT-based Continuous Critic learner for reinforcement learning.
+The ContinuousCritic class is designed  to output the parameters of a differentiable Critic function (e.g., linear, quadratic). 
+Usage examples: GBT-based SAC/DDPG/TD3 implementations.
+
+.. autoclass:: gbrl.ac_gbrl.ContinuousCritic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/actor_critic/DiscreteCritic.rst.txt b/_sources/actor_critic/DiscreteCritic.rst.txt
@@ -0,0 +1,12 @@
+DiscreteCritic Class
+====================
+
+This class implements a GBT-based Discrete Critic learner for reinforcement learning.
+The DiscreteCritic class is designed  to output the parameters of a discrete Critic (e.g., Q-function). 
+Usage examples: GBT-based DQN implementations.
+
+
+.. autoclass:: gbrl.ac_gbrl.DiscreteCritic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/actor_critic/GaussianActor.rst.txt b/_sources/actor_critic/GaussianActor.rst.txt
@@ -0,0 +1,11 @@
+GaussianActor Class
+===================
+
+This class implements a GBT-based Gaussian Actor for reinforcement learning.
+The GaussianActor outputs mu and sigma of a Gaussain Distribution. 
+Usage examples: GBT-based SAC/TD3/DDPG implementations.
+
+.. autoclass:: gbrl.ac_gbrl.GaussianActor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/actor_critic/ParametricActor.rst.txt b/_sources/actor_critic/ParametricActor.rst.txt
@@ -0,0 +1,11 @@
+ParametricActor Class
+=====================
+
+This class implements a GBT-based Parametric Actor for reinforcement learning.
+The ParametricActor outputs a single parameter per action dimension. 
+This allows the ParametericActor to parameterized deterministic policies or discrete stochastic policies such as a Categorical Distribution. 
+
+.. autoclass:: gbrl.ac_gbrl.ParametricActor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/actor_critic/index.rst.txt b/_sources/actor_critic/index.rst.txt
@@ -0,0 +1,14 @@
+Actor Critic Module
+====================
+
+This module handles Actor-Critic methods within the GBRL library. It provides various classes and functions to implement and train GBT-based Actor-Critic algorithm.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Classes:
+
+   ActorCritic
+   ParametricActor
+   GaussianActor
+   ContinuousCritic
+   DiscreteCritic