Deploying to gh-pages from @ d88ebe2 🚀

05_api_doc/env.html

@@ -810,7 +810,7 @@ <h3>BaseEnvManager<a class="headerlink" href="#baseenvmanager" title="Permalink
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about how to merge config, please refer to the system document of DI-engine             (<a class="reference external" href="../03_system/config.html">en link</a>).</p>
+<p>For more details about how to merge config, please refer to the system document of DI-engine             (<a class="reference external" href="../03_system/config.html">en link1</a>).</p>
 </div>
 </dd></dl>
 
@@ -1079,7 +1079,7 @@ <h3>BaseEnvManager<a class="headerlink" href="#baseenvmanager" title="Permalink
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 
@@ -1125,7 +1125,7 @@ <h3>BaseEnvManagerV2<a class="headerlink" href="#baseenvmanagerv2" title="Permal
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about new task pipeline, please refer to the system document of DI-engine         (<a class="reference external" href="../03_system/index.html">system en link</a>).</p>
+<p>For more details about new task pipeline, please refer to the system document of DI-engine         (<a class="reference external" href="../03_system/index.html">system en link3</a>).</p>
 </div>
 <dl class="simple">
 <dt>Interfaces:</dt><dd><p>reset, step, seed, close, enable_save_replay, launch, default_config, reward_shaping, enable_save_figure</p>
@@ -1151,7 +1151,7 @@ <h3>BaseEnvManagerV2<a class="headerlink" href="#baseenvmanagerv2" title="Permal
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about how to merge config, please refer to the system document of DI-engine             (<a class="reference external" href="../03_system/config.html">en link</a>).</p>
+<p>For more details about how to merge config, please refer to the system document of DI-engine             (<a class="reference external" href="../03_system/config.html">en link1</a>).</p>
 </div>
 </dd></dl>
 
@@ -1420,7 +1420,7 @@ <h3>BaseEnvManagerV2<a class="headerlink" href="#baseenvmanagerv2" title="Permal
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 
@@ -1583,7 +1583,7 @@ <h3>SyncSubprocessEnvManager<a class="headerlink" href="#syncsubprocessenvmanage
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 
@@ -1776,7 +1776,7 @@ <h3>SubprocessEnvManagerV2<a class="headerlink" href="#subprocessenvmanagerv2" t
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 
@@ -1957,7 +1957,7 @@ <h3>AsyncSubprocessEnvManager<a class="headerlink" href="#asyncsubprocessenvmana
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 
@@ -2087,7 +2087,7 @@ <h3>GymVectorEnvManager<a class="headerlink" href="#gymvectorenvmanager" title="
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link</a>).</p>
+<p>For more details about <code class="docutils literal notranslate"><span class="pre">dynamic_seed</span></code>, please refer to the best practice document of DI-engine             (<a class="reference external" href="../04_best_practice/random_seed.html">en link2</a>).</p>
 </div>
 </dd></dl>
 

05_api_doc/rl_utils.html

@@ -2981,11 +2981,11 @@ <h3>value_transform<a class="headerlink" href="#value-transform" title="Permalin
 <span class="sig-prename descclassname"><span class="pre">ding.rl_utils.value_rescale.</span></span><span class="sig-name descname"><span class="pre">value_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.01</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tensor</span></span></span><a class="reference internal" href="../_modules/ding/rl_utils/value_rescale.html#value_transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ding.rl_utils.value_rescale.value_transform" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="simple">
 <dt>Overview:</dt><dd><p>A function to reduce the scale of the action-value function.
-:math: <cite>h(x) = sign(x)(sqrt{(abs(x)+1)} - 1) + eps * x</cite> .</p>
+:math: <cite>h(x) = sign(x)(sqrt{(abs(x)+1)} - 1) + epsilon * x</cite> .</p>
 </dd>
 <dt>Arguments:</dt><dd><ul class="simple">
 <li><p>x: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">torch.Tensor</span></code>) The input tensor to be normalized.</p></li>
-<li><p>eps: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) The coefficient of the additive regularization term             to ensure h^{-1} is Lipschitz continuous</p></li>
+<li><p>eps: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) The coefficient of the additive regularization term             to ensure inverse function is Lipschitz continuous</p></li>
 </ul>
 </dd>
 <dt>Returns:</dt><dd><ul class="simple">
@@ -3013,10 +3013,10 @@ <h3>value_inv_transform<a class="headerlink" href="#value-inv-transform" title="
 </dl>
 </div></blockquote>
 <dl class="simple">
-<dt>rac{sqrt{1+4eps(<a href="#id5"><span class="problematic" id="id6">|</span></a>x|+1+eps)}-1}{2eps})}^2-1)` .</dt><dd><dl class="simple">
+<dt>rac{sqrt{1+4epsilon(<a href="#id5"><span class="problematic" id="id6">|</span></a>x|+1+epsilon)}-1}{2epsilon})}^2-1)` .</dt><dd><dl class="simple">
 <dt>Arguments:</dt><dd><ul class="simple">
 <li><p>x: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">torch.Tensor</span></code>) The input tensor to be unnormalized.</p></li>
-<li><p>eps: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) The coefficient of the additive regularization term             to ensure h^{-1} is Lipschitz continuous</p></li>
+<li><p>eps: (<code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) The coefficient of the additive regularization term             to ensure inverse function is Lipschitz continuous</p></li>
 </ul>
 </dd>
 <dt>Returns:</dt><dd><ul class="simple">

05_api_doc/torch_utils.html

@@ -3998,10 +3998,9 @@ <h3>Memory<a class="headerlink" href="#memory" title="Permalink to this heading"
 <span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hidden_state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ding/torch_utils/network/gtrxl.html#Memory.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ding.torch_utils.network.gtrxl.Memory.update" title="Permalink to this definition">¶</a></dt>
 <dd><dl>
 <dt>Overview:</dt><dd><p>Update the memory given a sequence of hidden states.
-Example for single layer:</p>
-<blockquote>
-<div><p>memory_len=3, hidden_size_len=2, bs=3</p>
+Example for single layer: (memory_len=3, hidden_size_len=2, bs=3)</p>
 <blockquote>
+<div><blockquote>
 <div><p>m00 m01 m02      h00 h01 h02              m20 m21 m22</p>
 </div></blockquote>
 <dl class="simple">
@@ -4145,11 +4144,7 @@ <h3>AttentionXL<a class="headerlink" href="#attentionxl" title="Permalink to thi
 </dl>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<dl class="simple">
-<dt>See the following material for better understanding:</dt><dd><p><a class="reference external" href="https://github.com/kimiyoung/transformer-xl/issues/8">https://github.com/kimiyoung/transformer-xl/issues/8</a>
-<a class="reference external" href="https://arxiv.org/pdf/1901.02860.pdf">https://arxiv.org/pdf/1901.02860.pdf</a> (Appendix B)</p>
-</dd>
-</dl>
+<p>See the following material for better understanding: <a class="reference external" href="https://github.com/kimiyoung/transformer-xl/issues/8">https://github.com/kimiyoung/transformer-xl/issues/8</a>             <a class="reference external" href="https://arxiv.org/pdf/1901.02860.pdf">https://arxiv.org/pdf/1901.02860.pdf</a> (Appendix B)</p>
 </div>
 <dl class="simple">
 <dt>Arguments:</dt><dd><ul class="simple">