Skip to content

Commit 6db1e58

Browse files
github-actions[bot]github-actions[bot]
committed
Deploy documentation to GitHub Pages
0 parents  commit 6db1e58

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+9903
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎_modules/gbrl/ac_gbrl.html

+958
Large diffs are not rendered by default.

‎_modules/gbrl/gbt.html

+479
Large diffs are not rendered by default.

‎_modules/index.html

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Overview: module code &mdash; GBRL 1.0.0 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
8+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
9+
10+
11+
<!--[if lt IE 9]>
12+
<script src="../_static/js/html5shiv.min.js"></script>
13+
<![endif]-->
14+
15+
<script src="../_static/jquery.js?v=5d32c60e"></script>
16+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17+
<script src="../_static/documentation_options.js?v=8d563738"></script>
18+
<script src="../_static/doctools.js?v=9a2dae69"></script>
19+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
20+
<script src="../_static/js/theme.js"></script>
21+
<link rel="index" title="Index" href="../genindex.html" />
22+
<link rel="search" title="Search" href="../search.html" />
23+
</head>
24+
25+
<body class="wy-body-for-nav">
26+
<div class="wy-grid-for-nav">
27+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
28+
<div class="wy-side-scroll">
29+
<div class="wy-side-nav-search" >
30+
31+
32+
33+
<a href="../index.html" class="icon icon-home">
34+
GBRL
35+
</a>
36+
<div class="version">
37+
master (1.0.0 )
38+
</div>
39+
<div role="search">
40+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
41+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
42+
<input type="hidden" name="check_keywords" value="yes" />
43+
<input type="hidden" name="area" value="default" />
44+
</form>
45+
</div>
46+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
47+
<p class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
48+
<ul>
49+
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
51+
</ul>
52+
<p class="caption" role="heading"><span class="caption-text">Documentation:</span></p>
53+
<ul>
54+
<li class="toctree-l1"><a class="reference internal" href="../gbt.html">Gradient Boosting Trees Module</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="../actor_critic/index.html">Actor Critic Module</a></li>
56+
</ul>
57+
58+
</div>
59+
</div>
60+
</nav>
61+
62+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
63+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
64+
<a href="../index.html">GBRL</a>
65+
</nav>
66+
67+
<div class="wy-nav-content">
68+
<div class="rst-content">
69+
<div role="navigation" aria-label="Page navigation">
70+
<ul class="wy-breadcrumbs">
71+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
72+
<li class="breadcrumb-item active">Overview: module code</li>
73+
<li class="wy-breadcrumbs-aside">
74+
</li>
75+
</ul>
76+
<hr/>
77+
</div>
78+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
79+
<div itemprop="articleBody">
80+
81+
<h1>All modules for which code is available</h1>
82+
<ul><li><a href="gbrl/ac_gbrl.html">gbrl.ac_gbrl</a></li>
83+
<li><a href="gbrl/gbt.html">gbrl.gbt</a></li>
84+
</ul>
85+
86+
</div>
87+
</div>
88+
<footer>
89+
90+
<hr/>
91+
92+
<div role="contentinfo">
93+
<p>&#169; Copyright 2024, NVIDIA Corporation.</p>
94+
</div>
95+
96+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
97+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
98+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
99+
100+
101+
</footer>
102+
</div>
103+
</div>
104+
</section>
105+
</div>
106+
<script>
107+
jQuery(function () {
108+
SphinxRtdTheme.Navigation.enable(true);
109+
});
110+
</script>
111+
112+
</body>
113+
</html>

‎_sources/actor_critic/ActorCritic.rst.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
ActorCritic Class
2+
=================
3+
4+
This class implements a GBT-based Actor-Critic learner for reinforcement learning.
5+
The ActorCritic class can be used with a shared-tree structure or a separate tree strucutre.
6+
Usage examples: GBT-based PPO/AWR implementations.
7+
8+
.. autoclass:: gbrl.ac_gbrl.ActorCritic
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:

‎_sources/actor_critic/ContinuousCritic.rst.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
ContinuousCritic Class
2+
======================
3+
4+
This class implements a GBT-based Continuous Critic learner for reinforcement learning.
5+
The ContinuousCritic class is designed to output the parameters of a differentiable Critic function (e.g., linear, quadratic).
6+
Usage examples: GBT-based SAC/DDPG/TD3 implementations.
7+
8+
.. autoclass:: gbrl.ac_gbrl.ContinuousCritic
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:

‎_sources/actor_critic/DiscreteCritic.rst.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
DiscreteCritic Class
2+
====================
3+
4+
This class implements a GBT-based Discrete Critic learner for reinforcement learning.
5+
The DiscreteCritic class is designed to output the parameters of a discrete Critic (e.g., Q-function).
6+
Usage examples: GBT-based DQN implementations.
7+
8+
9+
.. autoclass:: gbrl.ac_gbrl.DiscreteCritic
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎_sources/actor_critic/GaussianActor.rst.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
GaussianActor Class
2+
===================
3+
4+
This class implements a GBT-based Gaussian Actor for reinforcement learning.
5+
The GaussianActor outputs mu and sigma of a Gaussain Distribution.
6+
Usage examples: GBT-based SAC/TD3/DDPG implementations.
7+
8+
.. autoclass:: gbrl.ac_gbrl.GaussianActor
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:

‎_sources/actor_critic/ParametricActor.rst.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
ParametricActor Class
2+
=====================
3+
4+
This class implements a GBT-based Parametric Actor for reinforcement learning.
5+
The ParametricActor outputs a single parameter per action dimension.
6+
This allows the ParametericActor to parameterized deterministic policies or discrete stochastic policies such as a Categorical Distribution.
7+
8+
.. autoclass:: gbrl.ac_gbrl.ParametricActor
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:

‎_sources/actor_critic/index.rst.txt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Actor Critic Module
2+
====================
3+
4+
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.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Classes:
9+
10+
ActorCritic
11+
ParametricActor
12+
GaussianActor
13+
ContinuousCritic
14+
DiscreteCritic

0 commit comments

Comments
 (0)