Deploying to gh-pages from @ 1f6a787 🚀

microsoft · Oct 1, 2024 · d2fbf6c · d2fbf6c
1 parent b710cbb
commit d2fbf6c
Show file tree

Hide file tree

Showing 424 changed files with 1,928 additions and 1,831 deletions.
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.6.2.dev9+gfcc49aab5e',
+    VERSION: '0.6.2.dev10+g1f6a787c48',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api/mlos_bench/mlos_bench.config.html b/api/mlos_bench/mlos_bench.config.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.config package &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.config package &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.config.schemas.config_schemas.html b/api/mlos_bench/mlos_bench.config.schemas.config_schemas.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.config.schemas.config_schemas module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.config.schemas.config_schemas module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.config.schemas.html b/api/mlos_bench/mlos_bench.config.schemas.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.config.schemas package &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.config.schemas package &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.dict_templater.html b/api/mlos_bench/mlos_bench.dict_templater.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.dict_templater module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.dict_templater module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.environments.base_environment.html b/api/mlos_bench/mlos_bench.environments.base_environment.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments.base_environment module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments.base_environment module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.environments.composite_env.html b/api/mlos_bench/mlos_bench.environments.composite_env.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments.composite_env module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments.composite_env module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.environments.html b/api/mlos_bench/mlos_bench.environments.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments package &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments package &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -690,8 +690,8 @@
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">setup</span></code>(tunables[, global_config])</p></td>
 <td><p>Set up a new benchmark environment, if necessary.</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code>()</p></td>
-<td><p>Check the status of the benchmark environment.</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../../generated/mlos_bench.environments.MockEnv.html#mlos_bench.environments.MockEnv.status" title="mlos_bench.environments.MockEnv.status"><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code></a>()</p></td>
+<td><p>Produce mock benchmark status telemetry for one experiment.</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">teardown</span></code>()</p></td>
 <td><p>Tear down the benchmark environment.</p></td>
@@ -716,6 +716,22 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="mlos_bench.environments.MockEnv.status">
+<span class="sig-name descname"><span class="pre">status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="mlos_bench.environments.status.html#mlos_bench.environments.status.Status" title="mlos_bench.environments.status.Status"><span class="pre">Status</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">datetime</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mlos_bench.environments.MockEnv.status" title="Link to this definition">¶</a></dt>
+<dd><p>Produce mock benchmark status telemetry for one experiment.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>(benchmark_status, timestamp, telemetry)</strong><span class="classifier">(Status, datetime, list)</span></dt><dd><p>3-tuple of (benchmark status, timestamp, telemetry) values.
+<cite>timestamp</cite> is UTC time stamp of the status; it’s current time by default.
+<cite>telemetry</cite> is a list (maybe empty) of (timestamp, metric, value) triplets.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">
@@ -1029,6 +1045,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <li class="toctree-l1"><a class="reference internal" href="mlos_bench.environments.mock_env.html">mlos_bench.environments.mock_env module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="mlos_bench.environments.mock_env.html#mlos_bench.environments.mock_env.MockEnv"><code class="docutils literal notranslate"><span class="pre">MockEnv</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="mlos_bench.environments.mock_env.html#mlos_bench.environments.mock_env.MockEnv.run"><code class="docutils literal notranslate"><span class="pre">MockEnv.run()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="mlos_bench.environments.mock_env.html#mlos_bench.environments.mock_env.MockEnv.status"><code class="docutils literal notranslate"><span class="pre">MockEnv.status()</span></code></a></li>
 </ul>
 </li>
 </ul>

diff --git a/api/mlos_bench/mlos_bench.environments.local.html b/api/mlos_bench/mlos_bench.environments.local.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments.local package &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments.local package &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.environments.local.local_env.html b/api/mlos_bench/mlos_bench.environments.local.local_env.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments.local.local_env module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments.local.local_env module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/api/mlos_bench/mlos_bench.environments.local.local_fileshare_env.html b/api/mlos_bench/mlos_bench.environments.local.local_fileshare_env.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mlos_bench.environments.local.local_fileshare_env module &mdash; MLOS 0.6.2.dev9+gfcc49aab5e documentation</title>
+  <title>mlos_bench.environments.local.local_fileshare_env module &mdash; MLOS 0.6.2.dev10+g1f6a787c48 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -14,7 +14,7 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/documentation_options.js?v=76dedcbd"></script>
+        <script src="../../_static/documentation_options.js?v=cfd1bdc6"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             MLOS
           </a>
               <div class="version">
-                0.6.2.dev9+gfcc49aab5e
+                0.6.2.dev10+g1f6a787c48
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">