Deploying to gh-pages from @ 6b3ee10 🚀

content/basic_usage/index.html

@@ -309,16 +309,17 @@ <h1>Basic Usage<a class="headerlink" href="#basic-usage" title="Link to this hea
 <h2>Circuit Training<a class="headerlink" href="#circuit-training" title="Link to this heading">¶</a></h2>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
 
-<span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">&#39;CircuitTraining-Ariane-v0&#39;</span><span class="p">,</span>
-               <span class="n">netlist_file</span><span class="o">=</span><span class="s1">&#39;path/to/netlist.pb.txt&#39;</span><span class="p">)</span>
+<span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">&#39;CircuitTraining-Ariane-v0&#39;</span><span class="p">)</span>
+<span class="c1"># Other available environments:</span>
+<span class="c1"># env = gym.make(&#39;CircuitTraining-ToyMacro-v0&#39;)</span>
 </pre></div>
 </div>
 </section>
 <section id="web-navigation">
 <h2>Web Navigation<a class="headerlink" href="#web-navigation" title="Link to this heading">¶</a></h2>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
 
-<span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">&#39;WebNavigation-Difficulty-01-v0&#39;</span><span class="p">,</span> <span class="n">difficulty</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">num_websites</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">&#39;WebNavigation-Difficulty-01-v0&#39;</span><span class="p">,</span> <span class="n">num_websites</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
 </pre></div>
 </div>
 </section>
@@ -346,9 +347,13 @@ <h2>Installing from source<a class="headerlink" href="#installing-from-source" t
 <p>To install A2Perf from source, follow these steps:</p>
 <ol class="arabic">
 <li><p>Clone the repository:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Farama-Foundation/A2Perf.git
-<span class="nb">cd</span><span class="w"> </span>A2Perf
-git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init<span class="w"> </span>--recursive
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="w">   </span>git<span class="w"> </span>clone<span class="w"> </span>--recursive<span class="w"> </span>https://github.com/Farama-Foundation/A2Perf.git
+</pre></div>
+</div>
+<p>or</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="w">   </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Farama-Foundation/A2Perf.git
+<span class="w">   </span><span class="nb">cd</span><span class="w"> </span>A2Perf
+<span class="w">   </span>git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init<span class="w"> </span>--recursive
 </pre></div>
 </div>
 </li>

content/tutorials/generalization/index.html

@@ -359,10 +359,9 @@ <h4>Command Line Arguments<a class="headerlink" href="#command-line-arguments" t
 </section>
 <section id="running-locally-without-docker">
 <h3>Running Locally Without Docker<a class="headerlink" href="#running-locally-without-docker" title="Link to this heading">¶</a></h3>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">CUDA_VISIBLE_DEVICES</span><span class="o">=</span>-1<span class="w"> </span>python<span class="w"> </span>a2perf/launch/entrypoint.py<span class="w"> </span><span class="se">\</span>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">CUDA_VISIBLE_DEVICES</span><span class="o">=</span>-1<span class="w"> </span>a2perf<span class="w"> </span>../a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--root-dir<span class="o">=</span>~/gcs/a2perf/experiments/&lt;experiment-id&gt;/test/1<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--submission-gin-config-path<span class="o">=</span>../submission/configs/quadruped_locomotion/generalization.gin<span class="w"> </span><span class="se">\</span>
-<span class="w">  </span>--participant-module-path<span class="o">=</span>../a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--participant-args<span class="o">=</span><span class="s2">&quot;root_dir=~/gcs/a2perf/experiments/&lt;experiment-id&gt;/test/1,policy_name=greedy_policy&quot;</span>
 </pre></div>
 </div>

content/tutorials/inference/index.html

@@ -388,10 +388,9 @@ <h4>Running the Benchmark<a class="headerlink" href="#id1" title="Link to this h
 the following command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>A2Perf
 <span class="nb">export</span><span class="w"> </span><span class="nv">A2PERF_ROOT</span><span class="o">=</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>
-python<span class="w"> </span>a2perf/launch/entrypoint.py<span class="w"> </span><span class="se">\</span>
+a2perf<span class="w"> </span><span class="nv">$A2PERF_ROOT</span>/a2perf/a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--root-dir<span class="o">=</span>~/gcs/a2perf/experiments/&lt;experiment-id&gt;/test/1<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--submission-gin-config-path<span class="o">=</span><span class="nv">$A2PERF_ROOT</span>/a2perf/submission/configs/quadruped_locomotion/dog_pace/inference.gin<span class="w"> </span><span class="se">\</span>
-<span class="w">  </span>--participant-module-path<span class="o">=</span><span class="nv">$A2PERF_ROOT</span>/a2perf/a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--participant-args<span class="o">=</span><span class="s2">&quot;root_dir=~/gcs/a2perf/experiments/&lt;experiment-id&gt;/test/1,policy_name=greedy_policy&quot;</span>
 </pre></div>
 </div>

content/tutorials/training/index.html

@@ -510,10 +510,9 @@ <h4>Running the Benchmark<a class="headerlink" href="#id1" title="Link to this h
 Locomotion - Dog Pace environment with the following command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>A2perf
 <span class="nb">export</span><span class="w"> </span><span class="nv">A2PERF_ROOT</span><span class="o">=</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>
-python<span class="w"> </span>a2perf/launch/entrypoint.py<span class="w"> </span><span class="se">\</span>
+a2perf<span class="w"> </span><span class="nv">$A2PERF_ROOT</span>/a2perf/a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--root-dir<span class="o">=</span>~/gcs/a2perf/experiments/test_without_docker<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--submission-gin-config-path<span class="o">=</span><span class="nv">$A2PERF_ROOT</span>/a2perf/submission/configs/quadruped_locomotion/train.gin<span class="w"> </span><span class="se">\</span>
-<span class="w">  </span>--participant-module-path<span class="o">=</span><span class="nv">$A2PERF_ROOT</span>/a2perf/a2perf_benchmark_submission<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--participant-args<span class="o">=</span><span class="s2">&quot;gin_config_path=configs/quadruped_locomotion/dog_pace/ppo.gin&quot;</span>
 </pre></div>
 </div>