Deploying to gh-pages from @ 97aa35d 🚀

opendilab · Jun 22, 2024 · e93b6a3 · e93b6a3
1 parent 0e3b9a9
commit e93b6a3
Show file tree

Hide file tree

Showing 347 changed files with 236,363 additions and 1,124 deletions.
diff --git a/05_api_doc/agent.html b/05_api_doc/agent.html
diff --git a/05_api_doc/config.html b/05_api_doc/config.html
diff --git a/05_api_doc/data/buffer/buffer.html b/05_api_doc/data/buffer/buffer.html
diff --git a/05_api_doc/data/buffer/deque_buffer.html b/05_api_doc/data/buffer/deque_buffer.html
diff --git a/05_api_doc/data/buffer/index.html b/05_api_doc/data/buffer/index.html
@@ -306,14 +306,20 @@ <h1>data.buffer<a class="headerlink" href="#data-buffer" title="Permalink to thi
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="buffer.html">data.buffer.buffer</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="buffer.html#buffer">buffer</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="buffer.html#id1">Buffer</a></li>
+<li class="toctree-l3"><a class="reference internal" href="buffer.html#id1">Buffer</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="buffer.html#ding.data.buffer.buffer.Buffer"><code class="docutils literal notranslate"><span class="pre">Buffer</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="deque_buffer.html">data.buffer.deque_buffer</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="deque_buffer.html#deque-buffer">deque_buffer</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="deque_buffer.html#dequebuffer">DequeBuffer</a></li>
+<li class="toctree-l3"><a class="reference internal" href="deque_buffer.html#dequebuffer">DequeBuffer</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="deque_buffer.html#ding.data.buffer.deque_buffer.DequeBuffer"><code class="docutils literal notranslate"><span class="pre">DequeBuffer</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

diff --git a/05_api_doc/data/buffer/middleware/clone_object.html b/05_api_doc/data/buffer/middleware/clone_object.html
@@ -310,6 +310,16 @@ <h1>data.buffer.middleware.clone_object<a class="headerlink" href="#data-buffer-
 <h2>clone_object<a class="headerlink" href="#clone-object" title="Permalink to this heading">¶</a></h2>
 <section id="id1">
 <h3>clone_object<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h3>
+<dl class="py function">
+<dt class="sig sig-object py" id="ding.data.buffer.middleware.clone_object.clone_object">
+<span class="sig-prename descclassname"><span class="pre">ding.data.buffer.middleware.clone_object.</span></span><span class="sig-name descname"><span class="pre">clone_object</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/ding/data/buffer/middleware/clone_object.html#clone_object"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ding.data.buffer.middleware.clone_object.clone_object" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="simple">
+<dt>Overview:</dt><dd><p>This middleware freezes the objects saved in memory buffer and return copies during sampling,
+try this middleware when you need to keep the object unchanged in buffer, and modify        the object after sampling it (usually in multiple threads)</p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 </section>
 </section>
@@ -359,7 +369,10 @@ <h3>clone_object<a class="headerlink" href="#id1" title="Permalink to this headi
               <ul>
 <li><a class="reference internal" href="#">data.buffer.middleware.clone_object</a><ul>
 <li><a class="reference internal" href="#clone-object">clone_object</a><ul>
-<li><a class="reference internal" href="#id1">clone_object</a></li>
+<li><a class="reference internal" href="#id1">clone_object</a><ul>
+<li><a class="reference internal" href="#ding.data.buffer.middleware.clone_object.clone_object"><code class="docutils literal notranslate"><span class="pre">clone_object()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

diff --git a/05_api_doc/data/buffer/middleware/group_sample.html b/05_api_doc/data/buffer/middleware/group_sample.html
@@ -310,6 +310,21 @@ <h1>data.buffer.middleware.group_sample<a class="headerlink" href="#data-buffer-
 <h2>group_sample<a class="headerlink" href="#group-sample" title="Permalink to this heading">¶</a></h2>
 <section id="id1">
 <h3>group_sample<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h3>
+<dl class="py function">
+<dt class="sig sig-object py" id="ding.data.buffer.middleware.group_sample.group_sample">
+<span class="sig-prename descclassname"><span class="pre">ding.data.buffer.middleware.group_sample.</span></span><span class="sig-name descname"><span class="pre">group_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_in_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered_in_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_use_in_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">True</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">Callable</span></span></span><a class="reference internal" href="../../../../_modules/ding/data/buffer/middleware/group_sample.html#group_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ding.data.buffer.middleware.group_sample.group_sample" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="simple">
+<dt>Overview:</dt><dd><p>The middleware is designed to process the data in each group after sampling from the buffer.</p>
+</dd>
+<dt>Arguments:</dt><dd><ul class="simple">
+<li><p>size_in_group (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>): Sample size in each group.</p></li>
+<li><p>ordered_in_group (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>): Whether to keep the original order of records, default is true.</p></li>
+<li><p>max_use_in_group (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>): Whether to use as much data in each group as possible, default is true.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 </section>
 </section>
@@ -359,7 +374,10 @@ <h3>group_sample<a class="headerlink" href="#id1" title="Permalink to this headi
               <ul>
 <li><a class="reference internal" href="#">data.buffer.middleware.group_sample</a><ul>
 <li><a class="reference internal" href="#group-sample">group_sample</a><ul>
-<li><a class="reference internal" href="#id1">group_sample</a></li>
+<li><a class="reference internal" href="#id1">group_sample</a><ul>
+<li><a class="reference internal" href="#ding.data.buffer.middleware.group_sample.group_sample"><code class="docutils literal notranslate"><span class="pre">group_sample()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

diff --git a/05_api_doc/data/buffer/middleware/index.html b/05_api_doc/data/buffer/middleware/index.html
@@ -308,49 +308,70 @@ <h1>data.buffer.middleware<a class="headerlink" href="#data-buffer-middleware" t
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="clone_object.html">data.buffer.middleware.clone_object</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="clone_object.html#clone-object">clone_object</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="clone_object.html#id1">clone_object</a></li>
+<li class="toctree-l3"><a class="reference internal" href="clone_object.html#id1">clone_object</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="clone_object.html#ding.data.buffer.middleware.clone_object.clone_object"><code class="docutils literal notranslate"><span class="pre">clone_object()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="group_sample.html">data.buffer.middleware.group_sample</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="group_sample.html#group-sample">group_sample</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="group_sample.html#id1">group_sample</a></li>
+<li class="toctree-l3"><a class="reference internal" href="group_sample.html#id1">group_sample</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="group_sample.html#ding.data.buffer.middleware.group_sample.group_sample"><code class="docutils literal notranslate"><span class="pre">group_sample()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="padding.html">data.buffer.middleware.padding</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="padding.html#padding">padding</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="padding.html#id1">padding</a></li>
+<li class="toctree-l3"><a class="reference internal" href="padding.html#id1">padding</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="padding.html#ding.data.buffer.middleware.padding.padding"><code class="docutils literal notranslate"><span class="pre">padding()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="priority.html">data.buffer.middleware.priority</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="priority.html#priority">priority</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="priority.html#priorityexperiencereplay">PriorityExperienceReplay</a></li>
+<li class="toctree-l3"><a class="reference internal" href="priority.html#priorityexperiencereplay">PriorityExperienceReplay</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="priority.html#ding.data.buffer.middleware.priority.PriorityExperienceReplay"><code class="docutils literal notranslate"><span class="pre">PriorityExperienceReplay</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="sample_range_view.html">data.buffer.middleware.sample_range_view</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="sample_range_view.html#sample-range-view">sample_range_view</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="sample_range_view.html#id1">sample_range_view</a></li>
+<li class="toctree-l3"><a class="reference internal" href="sample_range_view.html#id1">sample_range_view</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="sample_range_view.html#ding.data.buffer.middleware.sample_range_view.sample_range_view"><code class="docutils literal notranslate"><span class="pre">sample_range_view()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="staleness_check.html">data.buffer.middleware.staleness_check</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="staleness_check.html#staleness-check">staleness_check</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="staleness_check.html#id1">staleness_check</a></li>
+<li class="toctree-l3"><a class="reference internal" href="staleness_check.html#id1">staleness_check</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="staleness_check.html#ding.data.buffer.middleware.staleness_check.staleness_check"><code class="docutils literal notranslate"><span class="pre">staleness_check()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="use_time_check.html">data.buffer.middleware.use_time_check</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="use_time_check.html#use-time-check">use_time_check</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="use_time_check.html#id1">use_time_check</a></li>
+<li class="toctree-l3"><a class="reference internal" href="use_time_check.html#id1">use_time_check</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="use_time_check.html#ding.data.buffer.middleware.use_time_check.use_time_check"><code class="docutils literal notranslate"><span class="pre">use_time_check()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

diff --git a/05_api_doc/data/buffer/middleware/padding.html b/05_api_doc/data/buffer/middleware/padding.html
@@ -310,6 +310,21 @@ <h1>data.buffer.middleware.padding<a class="headerlink" href="#data-buffer-middl
 <h2>padding<a class="headerlink" href="#padding" title="Permalink to this heading">¶</a></h2>
 <section id="id1">
 <h3>padding<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h3>
+<dl class="py function">
+<dt class="sig sig-object py" id="ding.data.buffer.middleware.padding.padding">
+<span class="sig-prename descclassname"><span class="pre">ding.data.buffer.middleware.padding.</span></span><span class="sig-name descname"><span class="pre">padding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'random'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/ding/data/buffer/middleware/padding.html#padding"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ding.data.buffer.middleware.padding.padding" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="simple">
+<dt>Overview:</dt><dd><p>Fill the nested buffer list to the same size as the largest list.
+The default policy <cite>random</cite> will randomly select data from each group
+and fill it into the current group list.</p>
+</dd>
+<dt>Arguments:</dt><dd><ul class="simple">
+<li><p>policy (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>): Padding policy, supports <cite>random</cite>, <cite>none</cite>.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 </section>
 </section>
@@ -359,7 +374,10 @@ <h3>padding<a class="headerlink" href="#id1" title="Permalink to this heading">
               <ul>
 <li><a class="reference internal" href="#">data.buffer.middleware.padding</a><ul>
 <li><a class="reference internal" href="#padding">padding</a><ul>
-<li><a class="reference internal" href="#id1">padding</a></li>
+<li><a class="reference internal" href="#id1">padding</a><ul>
+<li><a class="reference internal" href="#ding.data.buffer.middleware.padding.padding"><code class="docutils literal notranslate"><span class="pre">padding()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>