Skip to content

Commit

Permalink
Deploying to gh-pages from @ 533b3e7 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
zjowowen committed Jun 21, 2024
1 parent 95d2497 commit c4221a4
Show file tree
Hide file tree
Showing 10 changed files with 369 additions and 11 deletions.
196 changes: 196 additions & 0 deletions _modules/grl/agents/srpo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
<!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>grl.agents.srpo &mdash; GenerativeRL v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css" />


<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<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=2fea6348"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></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">
GenerativeRL
</a>
<div class="version">
0.0.1
</div>
<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">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/installation/index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/quick_start/index.html">Quick Start</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/agents/index.html">grl.agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/algorithms/index.html">grl.algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/datasets/index.html">grl.datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/generative_models/index.html">grl.generative_models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/neural_network/index.html">grl.neural_network</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/numerical_methods/index.html">grl.numerical_methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/rl_modules/index.html">grl.rl_modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/utils/index.html">grl.utils</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">GenerativeRL</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"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">grl.agents.srpo</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>Source code for grl.agents.srpo</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">torch</span>
<span class="kn">from</span> <span class="nn">easydict</span> <span class="kn">import</span> <span class="n">EasyDict</span>

<span class="kn">from</span> <span class="nn">grl.agents</span> <span class="kn">import</span> <span class="n">obs_transform</span><span class="p">,</span> <span class="n">action_transform</span>


<div class="viewcode-block" id="SRPOAgent">
<a class="viewcode-back" href="../../../api_doc/agents/index.html#grl.agents.SRPOAgent">[docs]</a>
<span class="k">class</span> <span class="nc">SRPOAgent</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Overview:</span>
<span class="sd"> The QGPO agent.</span>
<span class="sd"> Interface:</span>
<span class="sd"> ``__init__``, ``action``</span>
<span class="sd"> &quot;&quot;&quot;</span>

<div class="viewcode-block" id="SRPOAgent.__init__">
<a class="viewcode-back" href="../../../api_doc/agents/index.html#grl.agents.SRPOAgent.__init__">[docs]</a>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">config</span><span class="p">:</span> <span class="n">EasyDict</span><span class="p">,</span>
<span class="n">model</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ModuleDict</span><span class="p">],</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Overview:</span>
<span class="sd"> Initialize the agent.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> config (:obj:`EasyDict`): The configuration.</span>
<span class="sd"> model (:obj:`Union[torch.nn.Module, torch.nn.ModuleDict]`): The model.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
<span class="bp">self</span><span class="o">.</span><span class="n">device</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">device</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">)</span></div>


<div class="viewcode-block" id="SRPOAgent.act">
<a class="viewcode-back" href="../../../api_doc/agents/index.html#grl.agents.SRPOAgent.act">[docs]</a>
<span class="k">def</span> <span class="nf">act</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">obs</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Dict</span><span class="p">],</span>
<span class="n">return_as_torch_tensor</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Dict</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Overview:</span>
<span class="sd"> Given an observation, return an action.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> obs (:obj:`Union[np.ndarray, torch.Tensor, Dict]`): The observation.</span>
<span class="sd"> return_as_torch_tensor (:obj:`bool`): Whether to return the action as a torch tensor.</span>
<span class="sd"> Returns:</span>
<span class="sd"> action (:obj:`Union[np.ndarray, torch.Tensor, Dict]`): The action.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">obs</span> <span class="o">=</span> <span class="n">obs_transform</span><span class="p">(</span><span class="n">obs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">)</span>

<span class="k">with</span> <span class="n">torch</span><span class="o">.</span><span class="n">no_grad</span><span class="p">():</span>

<span class="c1"># ---------------------------------------</span>
<span class="c1"># Customized inference code ↓</span>
<span class="c1"># ---------------------------------------</span>

<span class="n">action</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>

<span class="c1"># ---------------------------------------</span>
<span class="c1"># Customized inference code ↑</span>
<span class="c1"># ---------------------------------------</span>

<span class="n">action</span> <span class="o">=</span> <span class="n">action_transform</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">return_as_torch_tensor</span><span class="p">)</span>

<span class="k">return</span> <span class="n">action</span></div>
</div>

</pre></div>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, OpenDILab Contributors.</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>
2 changes: 1 addition & 1 deletion _modules/grl/neural_network.html
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ <h1>Source code for grl.neural_network</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">result</span>


<span class="kn">from</span> <span class="nn">.transformers.dit</span> <span class="kn">import</span> <span class="n">DiT</span><span class="p">,</span> <span class="n">DiT1D</span><span class="p">,</span> <span class="n">DiT3D</span>
<span class="kn">from</span> <span class="nn">.transformers.dit</span> <span class="kn">import</span> <span class="n">DiT</span><span class="p">,</span> <span class="n">DiT1D</span><span class="p">,</span> <span class="n">DiT2D</span><span class="p">,</span> <span class="n">DiT3D</span>


<span class="k">class</span> <span class="nc">Sequential</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
Expand Down
18 changes: 15 additions & 3 deletions _modules/grl/neural_network/transformers/dit.html
Original file line number Diff line number Diff line change
Expand Up @@ -1306,6 +1306,8 @@ <h1>Source code for grl.neural_network.transformers.dit</h1><div class="highligh
<span class="k">return</span> <span class="n">x</span>


<div class="viewcode-block" id="DiT1D">
<a class="viewcode-back" href="../../../../api_doc/neural_network/index.html#grl.neural_network.DiT1D">[docs]</a>
<span class="k">class</span> <span class="nc">DiT1D</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Overview:</span>
Expand All @@ -1314,6 +1316,8 @@ <h1>Source code for grl.neural_network.transformers.dit</h1><div class="highligh
<span class="sd"> ``__init__``, ``forward``</span>
<span class="sd"> &quot;&quot;&quot;</span>

<div class="viewcode-block" id="DiT1D.__init__">
<a class="viewcode-back" href="../../../../api_doc/neural_network/index.html#grl.neural_network.DiT1D.__init__">[docs]</a>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">token_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
Expand Down Expand Up @@ -1366,8 +1370,11 @@ <h1>Source code for grl.neural_network.transformers.dit</h1><div class="highligh
<span class="p">]</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span> <span class="o">=</span> <span class="n">FinalLayer1D</span><span class="p">(</span><span class="n">hidden_size</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">out_channels</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">initialize_weights</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">initialize_weights</span><span class="p">()</span></div>


<div class="viewcode-block" id="DiT1D.initialize_weights">
<a class="viewcode-back" href="../../../../api_doc/neural_network/index.html#grl.neural_network.DiT1D.initialize_weights">[docs]</a>
<span class="k">def</span> <span class="nf">initialize_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Overview:</span>
Expand Down Expand Up @@ -1401,8 +1408,11 @@ <h1>Source code for grl.neural_network.transformers.dit</h1><div class="highligh
<span class="n">nn</span><span class="o">.</span><span class="n">init</span><span class="o">.</span><span class="n">constant_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="o">.</span><span class="n">adaLN_modulation</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">weight</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">nn</span><span class="o">.</span><span class="n">init</span><span class="o">.</span><span class="n">constant_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="o">.</span><span class="n">adaLN_modulation</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">bias</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">nn</span><span class="o">.</span><span class="n">init</span><span class="o">.</span><span class="n">constant_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="o">.</span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">nn</span><span class="o">.</span><span class="n">init</span><span class="o">.</span><span class="n">constant_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="o">.</span><span class="n">linear</span><span class="o">.</span><span class="n">bias</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">nn</span><span class="o">.</span><span class="n">init</span><span class="o">.</span><span class="n">constant_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="o">.</span><span class="n">linear</span><span class="o">.</span><span class="n">bias</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span></div>


<div class="viewcode-block" id="DiT1D.forward">
<a class="viewcode-back" href="../../../../api_doc/neural_network/index.html#grl.neural_network.DiT1D.forward">[docs]</a>
<span class="k">def</span> <span class="nf">forward</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">t</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span>
Expand Down Expand Up @@ -1434,7 +1444,9 @@ <h1>Source code for grl.neural_network.transformers.dit</h1><div class="highligh
<span class="k">for</span> <span class="n">block</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blocks</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">block</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span> <span class="c1"># (N, total_patches, hidden_size)</span>
<span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_layer</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span> <span class="c1"># (N, total_patches, C)</span>
<span class="k">return</span> <span class="n">x</span>
<span class="k">return</span> <span class="n">x</span></div>
</div>



<span class="n">DiT_1D</span> <span class="o">=</span> <span class="n">DiT1D</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
<h1>All modules for which code is available</h1>
<ul><li><a href="grl/agents/gm.html">grl.agents.gm</a></li>
<li><a href="grl/agents/qgpo.html">grl.agents.qgpo</a></li>
<li><a href="grl/agents/srpo.html">grl.agents.srpo</a></li>
<li><a href="grl/datasets/gp.html">grl.datasets.gp</a></li>
<li><a href="grl/datasets/qgpo.html">grl.datasets.qgpo</a></li>
<li><a href="grl/generative_models/conditional_flow_model/independent_conditional_flow_model.html">grl.generative_models.conditional_flow_model.independent_conditional_flow_model</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _sources/api_doc/neural_network/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ DiT

DiT1D
------
.. autoclass:: DiT2D
.. autoclass:: DiT1D
:special-members: __init__
:members:

Expand Down
Loading

0 comments on commit c4221a4

Please sign in to comment.