Francisco Rivera Valverde: [FIX] Cleanup ConfigSpace warnings (#183)

automl · May 20, 2021 · ab673c5 · ab673c5
1 parent 64cdc8a
commit ab673c5
Show file tree

Hide file tree

Showing 18 changed files with 416 additions and 351 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: aada98f00cd1f0e143fc1743c5771102
+config: fdc8792656888f5e7515f197b77125d6
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/API-Doc.html b/master/API-Doc.html
diff --git a/master/User-Guide.html b/master/User-Guide.html
@@ -3,15 +3,16 @@
 <html>
  <head>
  <meta charset="utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
  <title>User Guide &#8212; ConfigSpace documentation</title>
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
- <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
+ <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
  <script src="_static/jquery.js"></script>
  <script src="_static/underscore.js"></script>
  <script src="_static/doctools.js"></script>
- <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
  <link rel="next" title="API-Documentation" href="API-Doc.html" />
@@ -136,14 +137,14 @@
  </div>
  <div class="body col-md-9 content" role="main">
 
- <div class="section" id="user-guide">
+ <section id="user-guide">
 <h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1>
 <p>In this user guide, the concepts of using different hyperparameters, applying
 conditions and forbidden clauses to
 a configuration space are explained.</p>
 <p>These concepts will be introduced by defining a more complex configuration space
 for a support vector machine.</p>
-<div class="section" id="st-example-integer-hyperparameters-and-float-hyperparameters">
+<section id="st-example-integer-hyperparameters-and-float-hyperparameters">
 <h2>1st Example: Integer hyperparameters and float hyperparameters<a class="headerlink" href="#st-example-integer-hyperparameters-and-float-hyperparameters" title="Permalink to this headline">¶</a></h2>
 <p>Assume that we want to use a support vector machine (=SVM) for classification
 tasks and therefore, we want to optimize its hyperparameters:</p>
@@ -197,8 +198,8 @@ <h2>1st Example: Integer hyperparameters and float hyperparameters<a class="head
 <span class="go">42</span>
 </pre></div>
 </div>
-</div>
-<div class="section" id="nd-example-categorical-hyperparameters-and-conditions">
+</section>
+<section id="nd-example-categorical-hyperparameters-and-conditions">
 <h2>2nd Example: Categorical hyperparameters and conditions<a class="headerlink" href="#nd-example-categorical-hyperparameters-and-conditions" title="Permalink to this headline">¶</a></h2>
 <p>The scikit-learn SVM supports different kernels, such as an RBF, a sigmoid,
 a linear or a polynomial kernel. We want to include them in the configuration space.
@@ -282,8 +283,8 @@ <h2>2nd Example: Categorical hyperparameters and conditions<a class="headerlink"
 Due to floating-point inaccuracy, it is very unlikely that the
 <a class="reference internal" href="API-Doc.html#ConfigSpace.conditions.EqualsCondition" title="ConfigSpace.conditions.EqualsCondition"><code class="xref py py-class docutils literal notranslate"><span class="pre">EqualsCondition</span></code></a> is evaluated to True.</p>
 </div>
-</div>
-<div class="section" id="rd-example-forbidden-clauses">
+</section>
+<section id="rd-example-forbidden-clauses">
 <h2>3rd Example: Forbidden clauses<a class="headerlink" href="#rd-example-forbidden-clauses" title="Permalink to this headline">¶</a></h2>
 <p>It may occur that some states in the configuration space are not allowed.
 ConfigSpace supports this functionality by offering <a class="reference internal" href="API-Doc.html#forbidden-clauses"><span class="std std-ref">Forbidden Clauses</span></a>.</p>
@@ -338,8 +339,8 @@ <h2>3rd Example: Forbidden clauses<a class="headerlink" href="#rd-example-forbid
 <span class="go">[(Forbidden: penalty == &#39;l1&#39; &amp;&amp; Forbidden: loss == &#39;hinge&#39;), ...]</span>
 </pre></div>
 </div>
-</div>
-<div class="section" id="th-example-serialization">
+</section>
+<section id="th-example-serialization">
 <h2>4th Example Serialization<a class="headerlink" href="#th-example-serialization" title="Permalink to this headline">¶</a></h2>
 <p>If you want to use the configuration space in another tool, such as
 <a class="reference external" href="https://github.com/automl/CAVE">CAVE</a>, it is useful to store it to file.
@@ -359,8 +360,8 @@ <h2>4th Example Serialization<a class="headerlink" href="#th-example-serializati
 <span class="gp">... </span> <span class="n">restored_conf</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">json_string</span><span class="p">)</span>
 </pre></div>
 </div>
-</div>
-</div>
+</section>
+</section>
 
 
  </div>
@@ -382,7 +383,7 @@ <h2>4th Example Serialization<a class="headerlink" href="#th-example-serializati
  </p>
  <p>
  &copy; Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.<br/>
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
  </p>
  </div>
 </footer>

diff --git a/master/_modules/ConfigSpace/read_and_write/json.html b/master/_modules/ConfigSpace/read_and_write/json.html
@@ -5,9 +5,9 @@
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>ConfigSpace.read_and_write.json &#8212; ConfigSpace documentation</title>
- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
- <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../../../_static/bootstrap-sphinx.css" />
+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
  <script src="../../../_static/jquery.js"></script>
  <script src="../../../_static/underscore.js"></script>
  <script src="../../../_static/doctools.js"></script>
@@ -755,7 +755,7 @@ <h1>Source code for ConfigSpace.read_and_write.json</h1><div class="highlight"><
  </p>
  <p>
  &copy; Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.<br/>
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
  </p>
  </div>
 </footer>

diff --git a/master/_modules/ConfigSpace/read_and_write/pcs.html b/master/_modules/ConfigSpace/read_and_write/pcs.html
@@ -5,9 +5,9 @@
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>ConfigSpace.read_and_write.pcs &#8212; ConfigSpace documentation</title>
- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
- <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../../../_static/bootstrap-sphinx.css" />
+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
  <script src="../../../_static/jquery.js"></script>
  <script src="../../../_static/underscore.js"></script>
  <script src="../../../_static/doctools.js"></script>
@@ -609,7 +609,7 @@ <h1>Source code for ConfigSpace.read_and_write.pcs</h1><div class="highlight"><p
  </p>
  <p>
  &copy; Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.<br/>
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
  </p>
  </div>
 </footer>

diff --git a/master/_modules/ConfigSpace/read_and_write/pcs_new.html b/master/_modules/ConfigSpace/read_and_write/pcs_new.html
@@ -5,9 +5,9 @@
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>ConfigSpace.read_and_write.pcs_new &#8212; ConfigSpace documentation</title>
- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
- <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../../../_static/bootstrap-sphinx.css" />
+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
  <script src="../../../_static/jquery.js"></script>
  <script src="../../../_static/underscore.js"></script>
  <script src="../../../_static/doctools.js"></script>
@@ -190,8 +190,11 @@ <h1>Source code for ConfigSpace.read_and_write.pcs_new</h1><div class="highlight
 <span class="n">pp_e_notation</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Combine</span><span class="p">(</span><span class="n">pp_floatorint</span> <span class="o">+</span> <span class="n">pp_eorE</span> <span class="o">+</span> <span class="n">pp_int</span><span class="p">)</span>
 <span class="n">pp_number</span> <span class="o">=</span> <span class="n">pp_e_notation</span> <span class="o">|</span> <span class="n">pp_float</span> <span class="o">|</span> <span class="n">pp_int</span>
 <span class="n">pp_numberorname</span> <span class="o">=</span> <span class="n">pp_number</span> <span class="o">|</span> <span class="n">pp_param_name</span>
-<span class="n">pp_log</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Word</span><span class="p">(</span><span class="s2">&quot;log&quot;</span><span class="p">)</span>
-<span class="n">pp_connective</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Word</span><span class="p">(</span><span class="s2">&quot;||&quot;</span> <span class="o">+</span> <span class="s2">&quot;&amp;&amp;&quot;</span><span class="p">)</span>
+<span class="n">pp_log</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Literal</span><span class="p">(</span><span class="s2">&quot;log&quot;</span><span class="p">)</span>
+<span class="c1"># A word matches each character as a set. So &amp;&amp; is processed as &amp;</span>
+<span class="c1"># https://pythonhosted.org/pyparsing/pyparsing.Word-class.html</span>
+<span class="n">pp_connectiveOR</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Literal</span><span class="p">(</span><span class="s2">&quot;||&quot;</span><span class="p">)</span>
+<span class="n">pp_connectiveAND</span> <span class="o">=</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Literal</span><span class="p">(</span><span class="s2">&quot;&amp;&amp;&quot;</span><span class="p">)</span>
 <span class="n">pp_choices</span> <span class="o">=</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="n">pyparsing</span><span class="o">.</span><span class="n">OneOrMore</span><span class="p">(</span><span class="s2">&quot;,&quot;</span> <span class="o">+</span> <span class="n">pp_param_name</span><span class="p">))</span>
 <span class="n">pp_sequence</span> <span class="o">=</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="n">pyparsing</span><span class="o">.</span><span class="n">OneOrMore</span><span class="p">(</span><span class="s2">&quot;,&quot;</span> <span class="o">+</span> <span class="n">pp_param_name</span><span class="p">))</span>
 <span class="n">pp_ord_param</span> <span class="o">=</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="n">pp_param_type</span> <span class="o">+</span> <span class="s2">&quot;{&quot;</span> <span class="o">+</span> <span class="n">pp_sequence</span> <span class="o">+</span> <span class="s2">&quot;}&quot;</span> <span class="o">+</span> <span class="s2">&quot;[&quot;</span> <span class="o">+</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="s2">&quot;]&quot;</span>
@@ -204,7 +207,7 @@ <h1>Source code for ConfigSpace.read_and_write.pcs_new</h1><div class="highlight
  <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="s1">&#39;{&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">pp_param_val</span> <span class="o">+</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="s1">&#39;}&#39;</span><span class="p">)</span> <span class="o">+</span> \
  <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span>
  <span class="n">pyparsing</span><span class="o">.</span><span class="n">OneOrMore</span><span class="p">(</span>
- <span class="n">pp_connective</span> <span class="o">+</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="n">pp_param_operation</span>
+ <span class="p">(</span><span class="n">pp_connectiveAND</span> <span class="o">|</span> <span class="n">pp_connectiveOR</span><span class="p">)</span> <span class="o">+</span> <span class="n">pp_param_name</span> <span class="o">+</span> <span class="n">pp_param_operation</span>
  <span class="o">+</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="s1">&#39;{&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">pp_param_val</span> <span class="o">+</span> <span class="n">pyparsing</span><span class="o">.</span><span class="n">Optional</span><span class="p">(</span><span class="s1">&#39;}&#39;</span><span class="p">)</span>
  <span class="p">)</span>
  <span class="p">)</span>
@@ -767,7 +770,7 @@ <h1>Source code for ConfigSpace.read_and_write.pcs_new</h1><div class="highlight
  </p>
  <p>
  &copy; Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.<br/>
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
  </p>
  </div>
 </footer>

diff --git a/master/_modules/index.html b/master/_modules/index.html
@@ -5,9 +5,9 @@
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Overview: module code &#8212; ConfigSpace documentation</title>
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
- <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
+ <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  <script src="../_static/jquery.js"></script>
  <script src="../_static/underscore.js"></script>
  <script src="../_static/doctools.js"></script>
@@ -150,7 +150,7 @@ <h1>All modules for which code is available</h1>
  </p>
  <p>
  &copy; Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.<br/>
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
  </p>
  </div>
 </footer>

diff --git a/master/_static/basic.css b/master/_static/basic.css
@@ -130,7 +130,7 @@ ul.search li a {
  font-weight: bold;
 }
 
-ul.search li div.context {
+ul.search li p.context {
  color: #888;
  margin: 2px 0 0 30px;
  text-align: left;
@@ -508,6 +508,63 @@ table.hlist td {
  vertical-align: top;
 }
 
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
 
 /* -- other body styles ----------------------------------------------------- */
 
@@ -634,14 +691,6 @@ dl.glossary dt {
  font-size: 1.1em;
 }
 
-.optional {
- font-size: 1.3em;
-}
-
-.sig-paren {
- font-size: larger;
-}
-
 .versionmodified {
  font-style: italic;
 }
@@ -771,7 +820,11 @@ div.code-block-caption code {
 table.highlighttable td.linenos,
 span.linenos,
 div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
- user-select: none;
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
 }
 
 div.code-block-caption span.caption-number {
@@ -786,16 +839,6 @@ div.literal-block-wrapper {
  margin: 1em 0;
 }
 
-code.descname {
- background-color: transparent;
- font-weight: bold;
- font-size: 1.2em;
-}
-
-code.descclassname {
- background-color: transparent;
-}
-
 code.xref, a code {
  background-color: transparent;
  font-weight: bold;

diff --git a/master/_static/searchtools.js b/master/_static/searchtools.js
@@ -509,7 +509,7 @@ var Search = {
  var excerpt = ((start > 0) ? '...' : '') +
  $.trim(text.substr(start, 240)) +
  ((start + 240 - text.length) ? '...' : '');
- var rv = $('<div class="context"></div>').text(excerpt);
+ var rv = $('<p class="context"></p>').text(excerpt);
  $.each(hlwords, function() {
  rv = rv.highlightText(this, 'highlighted');
  });