Extended RTD usage docu

Author: DimitriWeiss

doc/_build/html/.doctrees/_autosummary/rtac.ac_functionalities.tournament_manager.doctree

@@ -426,7 +426,7 @@
 
 <dl class="py function">
 <dt class="sig sig-object py" id="rtac.ac_functionalities.tournament_manager.tourn_manager_factory">
-<span class="sig-prename descclassname"><span class="pre">rtac.ac_functionalities.tournament_manager.</span></span><span class="sig-name descname"><span class="pre">tourn_manager_factory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scenario</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ta_runner</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.ta_runner.html#rtac.ac_functionalities.ta_runner.BaseTARunner" title="rtac.ac_functionalities.ta_runner.BaseTARunner"><span class="pre">BaseTARunner</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.logs.html#rtac.ac_functionalities.logs.RTACLogs" title="rtac.ac_functionalities.logs.RTACLogs"><span class="pre">RTACLogs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtac_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.rtac_data.html#rtac.ac_functionalities.rtac_data.RTACData" title="rtac.ac_functionalities.rtac_data.RTACData"><span class="pre">RTACData</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="rtac.ac_functionalities.rtac_data.html#rtac.ac_functionalities.rtac_data.RTACDatapp" title="rtac.ac_functionalities.rtac_data.RTACDatapp"><span class="pre">RTACDatapp</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.AbstractTournamentManager" title="rtac.ac_functionalities.tournament_manager.AbstractTournamentManager"><span class="pre">AbstractTournamentManager</span></a></span></span><a class="reference internal" href="../_modules/rtac/ac_functionalities/tournament_manager.html#tourn_manager_factory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#rtac.ac_functionalities.tournament_manager.tourn_manager_factory" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">rtac.ac_functionalities.tournament_manager.</span></span><span class="sig-name descname"><span class="pre">tourn_manager_factory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scenario</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ta_runner</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.ta_runner.html#rtac.ac_functionalities.ta_runner.BaseTARunner" title="rtac.ac_functionalities.ta_runner.BaseTARunner"><span class="pre">BaseTARunner</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.logs.html#rtac.ac_functionalities.logs.RTACLogs" title="rtac.ac_functionalities.logs.RTACLogs"><span class="pre">RTACLogs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtac_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="rtac.ac_functionalities.rtac_data.html#rtac.ac_functionalities.rtac_data.RTACData" title="rtac.ac_functionalities.rtac_data.RTACData"><span class="pre">RTACData</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="rtac.ac_functionalities.rtac_data.html#rtac.ac_functionalities.rtac_data.RTACDatapp" title="rtac.ac_functionalities.rtac_data.RTACDatapp"><span class="pre">RTACDatapp</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.TournamentManager" title="rtac.ac_functionalities.tournament_manager.TournamentManager"><span class="pre">TournamentManager</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.TournamentManagerCPPL" title="rtac.ac_functionalities.tournament_manager.TournamentManagerCPPL"><span class="pre">TournamentManagerCPPL</span></a></span></span><a class="reference internal" href="../_modules/rtac/ac_functionalities/tournament_manager.html#tourn_manager_factory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#rtac.ac_functionalities.tournament_manager.tourn_manager_factory" title="Permalink to this definition"></a></dt>
 <dd><p>Class factory to return the initialized TournamentManager class
 appropriate to the RTAC method scenario.ac.</p>
 <dl class="field-list simple">
@@ -444,7 +444,7 @@
 scenario.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.AbstractTournamentManager" title="rtac.ac_functionalities.tournament_manager.AbstractTournamentManager">AbstractTournamentManager</a></p>
+<dd class="field-odd"><p><a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.TournamentManager" title="rtac.ac_functionalities.tournament_manager.TournamentManager">TournamentManager</a> or <a class="reference internal" href="#rtac.ac_functionalities.tournament_manager.TournamentManagerCPPL" title="rtac.ac_functionalities.tournament_manager.TournamentManagerCPPL">TournamentManagerCPPL</a></p>
 </dd>
 </dl>
 </dd></dl>

doc/_build/html/.doctrees/environment.pickle

@@ -849,7 +849,7 @@ <h1>Source code for rtac.ac_functionalities.tournament_manager</h1><div class="h
 <div class="viewcode-block" id="tourn_manager_factory"><a class="viewcode-back" href="../../../_autosummary/rtac.ac_functionalities.tournament_manager.html#rtac.ac_functionalities.tournament_manager.tourn_manager_factory">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">tourn_manager_factory</span><span class="p">(</span><span class="n">scenario</span><span class="p">:</span> <span class="n">argparse</span><span class="o">.</span><span class="n">Namespace</span><span class="p">,</span>
                           <span class="n">ta_runner</span><span class="p">:</span> <span class="n">BaseTARunner</span><span class="p">,</span> <span class="n">logs</span><span class="p">:</span> <span class="n">RTACLogs</span><span class="p">,</span>
                           <span class="n">rtac_data</span><span class="p">:</span> <span class="n">RTACData</span> <span class="o">|</span> <span class="n">RTACDatapp</span>
-                          <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AbstractTournamentManager</span><span class="p">:</span>
+                          <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TournamentManager</span> <span class="o">|</span> <span class="n">TournamentManagerCPPL</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Class factory to return the initialized TournamentManager class</span>
 <span class="sd">    appropriate to the RTAC method scenario.ac.</span>
@@ -868,7 +868,7 @@ <h1>Source code for rtac.ac_functionalities.tournament_manager</h1><div class="h
 
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
-<span class="sd">    AbstractTournamentManager</span>
+<span class="sd">    TournamentManager or TournamentManagerCPPL</span>
 <span class="sd">        Initialized TournamentManager object matching the RTAC method of the </span>
 <span class="sd">        scenario.</span>
 <span class="sd">    &quot;&quot;&quot;</span>

doc/_build/html/.doctrees/usage.doctree

@@ -97,8 +97,6 @@ <h1>Source code for rtac.utils.background_thread_control</h1><div class="highlig
     <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;MKL_NUM_THREADS&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span>         <span class="c1"># MKL (Intel Math Kernel Lib)</span>
     <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;VECLIB_MAXIMUM_THREADS&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span>  <span class="c1"># macOS Accelerate</span>
     <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;NUMEXPR_NUM_THREADS&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span>     <span class="c1"># NumExpr</span>
-
-    <span class="c1"># Optional: Limit threadpool (used by joblib, e.g. in sklearn)</span>
     <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;JOBLIB_START_METHOD&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;fork&quot;</span>  <span class="c1"># safer parallelism on Unix</span></div>
 </pre></div>
 

doc/_build/html/_autosummary/rtac.ac_functionalities.tournament_manager.html

@@ -220,3 +220,17 @@ Below, you will find a table with hyperparameters accepted by the RAC methods in
      - int
      - 2
      - Number of gray-box features used.
+
+
+What To Use
+-----------
+What you can use depends on the availability of features in your setting and if you would like to include them. In the following, a table shows the possible RAC method use based on the feature availability.
+
++-------------------+---------+--------+----------+---------------------+--------------+
+| Features          | ReACTR  | CPPL   | ReACTR++ | Gray-box ReACTR(++) | Gray-box CPPL|
++-------------------+---------+--------+----------+---------------------+--------------+
+| Problem Instance  | ✗       | ✓      | ✗        | ✗                   | ✓            |
++-------------------+---------+--------+----------+---------------------+--------------+
+| Runtime output    | ✗       | ✗      | ✓        | ✓                   | ✓            |
++-------------------+---------+--------+----------+---------------------+--------------+
+

doc/_build/html/_modules/rtac/ac_functionalities/tournament_manager.html

@@ -99,6 +99,7 @@ <h1>rtac<a class="headerlink" href="#rtac" title="Permalink to this heading">
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="usage.html#necessary-provisions">Necessary Provisions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage.html#hyperparameters">Hyperparameters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage.html#what-to-use">What To Use</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>