Deploying to gh-pages from @ 0a28bc3 🚀

capitalone · Jun 6, 2024 · 9f5c77e · 9f5c77e
1 parent 57332a8
commit 9f5c77e
Show file tree

Hide file tree

Showing 42 changed files with 167 additions and 151 deletions.
diff --git a/.buildinfo b/.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: 5153468b3cc10d64276e8d2359b5252c
+config: 5b25f2df92cddedc41025700c107d7a4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_images/experiments-table.png b/_images/experiments-table.png
diff --git a/_sources/visualizations/experiments-table.ipynb.txt b/_sources/visualizations/experiments-table.ipynb.txt
@@ -53,9 +53,11 @@
     "\n",
     "for i in range(0, 24):\n",
     "    experiment = project.log_experiment()\n",
-    "    experiment.log_parameter(name=\"max_depth\", value=random.randrange(5, 25, 5))\n",
-    "    experiment.log_parameter(name=\"n_estimators\", value=random.randrange(2, 12, 2))\n",
-    "    experiment.log_metric(name=\"accuracy\", value=random.random())"
+    "    experiment.log_parameter(name=\"max_depth\", tags=[\"show me\"], value=random.randrange(5, 25, 5))\n",
+    "    experiment.log_parameter(name=\"n_estimators\", tags=[\"show me\"], value=random.randrange(2, 12, 2))\n",
+    "    experiment.log_parameter(name=\"extra_parameter\", value=random.randrange(0, 2))\n",
+    "    experiment.log_metric(name=\"accuracy\", tags=[\"show me\"], value=random.random())\n",
+    "    experiment.log_metric(name=\"extra_metric\", value=random.random())"
    ]
   },
   {
@@ -67,26 +69,24 @@
     "logged and view the table right in this notebook with `show`. The Dash application\n",
     "itself will be running on http://127.0.0.1:8050/ when running locally. Use the\n",
     "`serve` command to launch the server directly without rendering the widget in the\n",
-    "current Python interpreter."
+    "current Python interpreter.\n",
+    "\n",
+    "**Note:** The parameters and metrics shown when the `ExperimentsTable` first renders\n",
+    "can be controlled by the class' other input arguments. The configuration below will\n",
+    "only show the metrics and parameters tagged with \"show me\" when the table first renders."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
    "id": "8cb7d191-2b60-4984-80ba-dbb2b310c4bf",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Dash is running on http://127.0.0.1:8050/\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "ExperimentsTable(\n",
     "    experiments=project.experiments(),\n",
+    "    parameter_query_tags=[\"show me\"],\n",
+    "    metric_query_tags=[\"show me\"],\n",
     ").show()"
    ]
   },
@@ -115,7 +115,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.10.14"
   }
  },
  "nbformat": 4,

diff --git a/api_reference.html b/api_reference.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Representing model metadata with a schema" href="schema-representation.html" /><link rel="prev" title="FAQs" href="faqs.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>API Reference - rubicon-ml v0.7.3</title>
+        <title>API Reference - rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -3292,7 +3292,7 @@ <h2>sklearn<a class="headerlink" href="#sklearn" title="Link to this heading">¶
 
 <dl class="py class">
 <dt class="sig sig-object py" id="rubicon_ml.viz.ExperimentsTable">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">rubicon_ml.viz.</span></span><span class="sig-name descname"><span class="pre">ExperimentsTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">experiments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_selectable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rubicon_ml.viz.ExperimentsTable" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">rubicon_ml.viz.</span></span><span class="sig-name descname"><span class="pre">ExperimentsTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">experiments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_selectable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_query_tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_query_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_query_tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_query_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rubicon_ml.viz.ExperimentsTable" title="Link to this definition">¶</a></dt>
 <dd><p>Visualize the experiments <cite>experiments</cite> and their metadata, metrics,
 and parameters in a tabular format.</p>
 <dl class="field-list simple">
@@ -3304,6 +3304,25 @@ <h2>sklearn<a class="headerlink" href="#sklearn" title="Link to this heading">¶
 <dt><strong>is_selectable</strong><span class="classifier">bool, optional</span></dt><dd><p>True to enable selection of the rows in the table, False otherwise.
 Defaults to True.</p>
 </dd>
+<dt><strong>metric_names</strong><span class="classifier">list of str</span></dt><dd><p>If provided, only show the metrics with names in the given list. If
+<cite>metric_query_tags</cite> are also provided, this will only select metrics
+from the tag-filtered results.</p>
+</dd>
+<dt><strong>metric_query_tags</strong><span class="classifier">list of str, optional</span></dt><dd><p>If provided, only show the metrics with the given tags in the table.</p>
+</dd>
+<dt><strong>metric_query_type</strong><span class="classifier">‘and’ or ‘or’, optional</span></dt><dd><p>When <cite>metric_query_tags</cite> are given, ‘and’ shows the metrics with all of
+the given tags and ‘or’ shows the metrics with any of the given tags.</p>
+</dd>
+<dt><strong>parameter_names</strong><span class="classifier">list of str</span></dt><dd><p>If provided, only show the parameters with names in the given list. If
+<cite>parameter_query_tags</cite> are also provided, this will only select
+parameters from the tag-filtered results.</p>
+</dd>
+<dt><strong>parameter_query_tags</strong><span class="classifier">list of str, optional</span></dt><dd><p>If provided, only show the parameters with the given tags in the table.</p>
+</dd>
+<dt><strong>parameter_query_type</strong><span class="classifier">‘and’ or ‘or’, optional</span></dt><dd><p>When <cite>parameter_query_tags</cite> are given, ‘and’ shows the paramters with
+all of the given tags and ‘or’ shows the parameters with any of the
+given tags.</p>
+</dd>
 </dl>
 </dd>
 </dl>

diff --git a/contribute-schema.html b/contribute-schema.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Contributing" href="contributing.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>Contribute a schema - rubicon-ml v0.7.3</title>
+        <title>Contribute a schema - rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

diff --git a/contributing.html b/contributing.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contribute a schema" href="contribute-schema.html" /><link rel="prev" title="Representing model metadata with a schema" href="schema-representation.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>Contributing - rubicon-ml v0.7.3</title>
+        <title>Contributing - rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

diff --git a/faqs.html b/faqs.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="API Reference" href="api_reference.html" /><link rel="prev" title="Glossary" href="glossary.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>FAQs - rubicon-ml v0.7.3</title>
+        <title>FAQs - rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

diff --git a/genindex.html b/genindex.html
@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 --><title>Index - rubicon-ml v0.7.3</title>
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 --><title>Index - rubicon-ml v0.7.4</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -179,7 +179,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -207,7 +207,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

diff --git a/glossary.html b/glossary.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="FAQs" href="faqs.html" /><link rel="prev" title="Visualize Logged Dataframes" href="logging-examples/visualizing-logged-dataframes.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>Glossary - rubicon-ml v0.7.3</title>
+        <title>Glossary - rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Logging Experiments" href="quick-look/logging-experiments.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>rubicon-ml v0.7.3</title>
+        <title>rubicon-ml v0.7.4</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -181,7 +181,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="#"><div class="brand"><div class='version'>rubicon-ml v0.7.3</div></div></a>
+      <a href="#"><div class="brand"><div class='version'>rubicon-ml v0.7.4</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -209,7 +209,7 @@
     <img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
   </div>
 
-  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.3</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.7.4</div></span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">