Update docs from 30c5fba

microsoft · Jun 28, 2023 · ec89dc0 · ec89dc0
1 parent 9609ad2
commit ec89dc0
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/_modules/olive/engine/engine.html b/_modules/olive/engine/engine.html
@@ -693,7 +693,7 @@ <h1>Source code for olive.engine.engine</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">goals</span><span class="p">:</span>
             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Resolving goals: </span><span class="si">{</span><span class="n">goals</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
-        <span class="n">baseline</span> <span class="o">=</span> <span class="n">MetricResult</span><span class="p">()</span>
+        <span class="n">baseline</span> <span class="o">=</span> <span class="kc">None</span>
         <span class="k">for</span> <span class="n">goal</span> <span class="ow">in</span> <span class="n">goals</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
             <span class="n">_evaluated</span> <span class="o">=</span> <span class="kc">False</span>
             <span class="k">for</span> <span class="n">sub_goal</span> <span class="ow">in</span> <span class="n">goal</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>

diff --git a/_modules/olive/evaluator/metric.html b/_modules/olive/evaluator/metric.html
@@ -277,7 +277,7 @@ <h1>Source code for olive.evaluator.metric</h1><div class="highlight"><pre>
 
 
 <span class="k">class</span> <span class="nc">MetricResult</span><span class="p">(</span><span class="n">ConfigDictBase</span><span class="p">):</span>
-    <span class="n">__root__</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">SubMetricResult</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
+    <span class="n">__root__</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">SubMetricResult</span><span class="p">]</span>
     <span class="n">delimiter</span><span class="p">:</span> <span class="n">ClassVar</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;-&quot;</span>
 
     <span class="k">def</span> <span class="nf">get_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">,</span> <span class="n">sub_type_name</span><span class="p">):</span>

diff --git a/_modules/olive/systems/docker/docker_system.html b/_modules/olive/systems/docker/docker_system.html
@@ -273,20 +273,36 @@ <h1>Source code for olive.systems.docker.docker_system</h1><div class="highlight
                 <span class="n">image</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="n">eval_command</span><span class="p">,</span> <span class="n">volumes</span><span class="o">=</span><span class="n">volumes_list</span><span class="p">,</span> <span class="n">detach</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">run_command</span>
             <span class="p">)</span>
             <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">container</span><span class="o">.</span><span class="n">logs</span><span class="p">(</span><span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
-                <span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
+                <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
+            <span class="n">exit_code</span> <span class="o">=</span> <span class="n">container</span><span class="o">.</span><span class="n">wait</span><span class="p">()[</span><span class="s2">&quot;StatusCode&quot;</span><span class="p">]</span>
+            <span class="c1"># ignore the remove in case user wants to debug</span>
+            <span class="c1"># container.remove()</span>
+            <span class="k">if</span> <span class="n">exit_code</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="n">docker</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">ContainerError</span><span class="p">(</span>
+                    <span class="n">container</span><span class="p">,</span> <span class="n">exit_code</span><span class="p">,</span> <span class="n">eval_command</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> <span class="s2">&quot;Docker container evaluation failed&quot;</span>
+                <span class="p">)</span>
             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Docker container evaluation completed successfully&quot;</span><span class="p">)</span>
         <span class="k">finally</span><span class="p">:</span>
             <span class="c1"># clean up dev mount regardless of whether the run was successful or not</span>
             <span class="c1"># otherwise __pycache__ will be created in the dev mount and will cause issues</span>
             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_dev</span><span class="p">:</span>
                 <span class="n">clean_up_mount_path</span><span class="p">,</span> <span class="n">clean_up_mount_str</span> <span class="o">=</span> <span class="n">docker_utils</span><span class="o">.</span><span class="n">create_dev_cleanup_mount</span><span class="p">(</span><span class="n">container_root_path</span><span class="p">)</span>
                 <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Cleaning up dev mount&quot;</span><span class="p">)</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">docker_client</span><span class="o">.</span><span class="n">containers</span><span class="o">.</span><span class="n">run</span><span class="p">(</span>
-                    <span class="n">image</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span>
-                    <span class="n">command</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;python </span><span class="si">{</span><span class="n">clean_up_mount_path</span><span class="si">}</span><span class="s2"> --dev_mount_path </span><span class="si">{</span><span class="n">dev_mount_path</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
-                    <span class="n">volumes</span><span class="o">=</span><span class="p">[</span><span class="n">dev_mount_str</span><span class="p">,</span> <span class="n">clean_up_mount_str</span><span class="p">],</span>
-                <span class="p">)</span>
-                <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Dev mount cleaned up successfully&quot;</span><span class="p">)</span>
+                <span class="k">try</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">docker_client</span><span class="o">.</span><span class="n">containers</span><span class="o">.</span><span class="n">run</span><span class="p">(</span>
+                        <span class="n">image</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span>
+                        <span class="n">command</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;python </span><span class="si">{</span><span class="n">clean_up_mount_path</span><span class="si">}</span><span class="s2"> --dev_mount_path </span><span class="si">{</span><span class="n">dev_mount_path</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
+                        <span class="n">volumes</span><span class="o">=</span><span class="p">[</span><span class="n">dev_mount_str</span><span class="p">,</span> <span class="n">clean_up_mount_str</span><span class="p">],</span>
+                        <span class="c1"># remove the container as it is used to clean up the dev mount only</span>
+                        <span class="n">remove</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+                    <span class="p">)</span>
+                    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Dev mount cleaned up successfully&quot;</span><span class="p">)</span>
+                <span class="k">except</span> <span class="p">(</span>
+                    <span class="n">docker</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">ContainerError</span><span class="p">,</span>
+                    <span class="n">docker</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">ImageNotFound</span><span class="p">,</span>
+                    <span class="n">docker</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">APIError</span><span class="p">,</span>
+                <span class="p">):</span>
+                    <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;Dev mount cleanup failed&quot;</span><span class="p">)</span>
 
         <span class="n">metric_json</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">output_local_path</span><span class="p">)</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">eval_output_name</span><span class="si">}</span><span class="s2">&quot;</span>
         <span class="k">return</span> <span class="n">metric_json</span></div>