-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 533b3e7 🚀
- Loading branch information
Showing
10 changed files
with
369 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 — 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">"""</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"> """</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">"""</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"> """</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">-></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">"""</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"> """</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>© 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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,7 +37,7 @@ DiT | |
|
||
DiT1D | ||
------ | ||
.. autoclass:: DiT2D | ||
.. autoclass:: DiT1D | ||
:special-members: __init__ | ||
:members: | ||
|
||
|
Oops, something went wrong.