Update Sphinx documentation

Author: actions-user

docs/py_docs/build/html/.doctrees/environment.pickle

@@ -304,18 +304,18 @@ <h1>Source code for perceptionmetrics.cli</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;rellis3d&quot;</span> <span class="ow">and</span> <span class="n">ontology</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;--dataset_ontology is required for &#39;rellis3d&#39; format&quot;</span><span class="p">)</span>
 
-    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;goose&quot;</span><span class="p">,</span> <span class="s2">&quot;generic&quot;</span><span class="p">]:</span>
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;goose&quot;</span><span class="p">,</span> <span class="s2">&quot;generic&quot;</span><span class="p">,</span> <span class="s2">&quot;cityscapes&quot;</span><span class="p">]:</span>
         <span class="k">if</span> <span class="s2">&quot;train&quot;</span> <span class="ow">in</span> <span class="n">split</span> <span class="ow">and</span> <span class="n">train_dataset_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-                <span class="s2">&quot;--train_dataset_dir is required for &#39;train&#39; split in &#39;goose&#39; and &#39;generic&#39; formats&quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;--train_dataset_dir is required for &#39;train&#39; split in &#39;</span><span class="si">{</span><span class="n">dataset_format</span><span class="si">}</span><span class="s2">&#39; format&quot;</span>
             <span class="p">)</span>
         <span class="k">elif</span> <span class="s2">&quot;val&quot;</span> <span class="ow">in</span> <span class="n">split</span> <span class="ow">and</span> <span class="n">val_dataset_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-                <span class="s2">&quot;--val_dataset_dir is required for &#39;val&#39; split in &#39;goose&#39; and &#39;generic&#39; formats&quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;--val_dataset_dir is required for &#39;val&#39; split in &#39;</span><span class="si">{</span><span class="n">dataset_format</span><span class="si">}</span><span class="s2">&#39; format&quot;</span>
             <span class="p">)</span>
         <span class="k">elif</span> <span class="s2">&quot;test&quot;</span> <span class="ow">in</span> <span class="n">split</span> <span class="ow">and</span> <span class="n">test_dataset_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-                <span class="s2">&quot;--test_dataset_dir is required for &#39;test&#39; split in &#39;goose&#39; and &#39;generic&#39; formats&quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;--test_dataset_dir is required for &#39;test&#39; split in &#39;</span><span class="si">{</span><span class="n">dataset_format</span><span class="si">}</span><span class="s2">&#39; format&quot;</span>
             <span class="p">)</span>
 
         <span class="k">if</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;generic&quot;</span><span class="p">:</span>
@@ -336,18 +336,27 @@ <h1>Source code for perceptionmetrics.cli</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">dataset_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;--dataset_dir is required for &#39;coco&#39; format&quot;</span><span class="p">)</span>
 
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;yolo&quot;</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">dataset_fname</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;--dataset_fname is required for &#39;yolo&#39; format&quot;</span><span class="p">)</span>
+
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;nuimages&quot;</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">dataset_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;--dataset_dir is required for &#39;nuimages&#39; format&quot;</span><span class="p">)</span>
+
     <span class="k">else</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dataset format not supported: </span><span class="si">{</span><span class="n">dataset_format</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
     <span class="c1"># Get arguments to init dataset</span>
     <span class="k">if</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;gaia&quot;</span><span class="p">:</span>
         <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;dataset_fname&quot;</span><span class="p">:</span> <span class="n">dataset_fname</span><span class="p">}</span>
-    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;rellis3d&quot;</span><span class="p">:</span>
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;rellis3d&quot;</span><span class="p">,</span> <span class="s2">&quot;wildscenes&quot;</span><span class="p">]:</span>
         <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;dataset_dir&quot;</span><span class="p">:</span> <span class="n">dataset_dir</span><span class="p">,</span>
             <span class="s2">&quot;split_dir&quot;</span><span class="p">:</span> <span class="n">split_dir</span><span class="p">,</span>
-            <span class="s2">&quot;ontology_fname&quot;</span><span class="p">:</span> <span class="n">ontology</span><span class="p">,</span>
         <span class="p">}</span>
+        <span class="k">if</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;rellis3d&quot;</span><span class="p">:</span>
+            <span class="n">dataset_args</span><span class="p">[</span><span class="s2">&quot;ontology_fname&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ontology</span>
     <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;goose&quot;</span><span class="p">:</span>
         <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;train_dataset_dir&quot;</span><span class="p">:</span> <span class="n">train_dataset_dir</span><span class="p">,</span>
@@ -363,6 +372,12 @@ <h1>Source code for perceptionmetrics.cli</h1><div class="highlight"><pre>
             <span class="s2">&quot;val_dataset_dir&quot;</span><span class="p">:</span> <span class="n">val_dataset_dir</span><span class="p">,</span>
             <span class="s2">&quot;test_dataset_dir&quot;</span><span class="p">:</span> <span class="n">test_dataset_dir</span><span class="p">,</span>
         <span class="p">}</span>
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;cityscapes&quot;</span><span class="p">:</span>
+        <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s2">&quot;train_dataset_root&quot;</span><span class="p">:</span> <span class="n">train_dataset_dir</span><span class="p">,</span>
+            <span class="s2">&quot;val_dataset_root&quot;</span><span class="p">:</span> <span class="n">val_dataset_dir</span><span class="p">,</span>
+            <span class="s2">&quot;test_dataset_root&quot;</span><span class="p">:</span> <span class="n">test_dataset_dir</span><span class="p">,</span>
+        <span class="p">}</span>
     <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;rugd&quot;</span><span class="p">:</span>
         <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;images_dir&quot;</span><span class="p">:</span> <span class="n">images_dir</span><span class="p">,</span>
@@ -383,6 +398,18 @@ <h1>Source code for perceptionmetrics.cli</h1><div class="highlight"><pre>
             <span class="s2">&quot;image_dir&quot;</span><span class="p">:</span> <span class="n">image_dir</span><span class="p">,</span>
             <span class="s2">&quot;split&quot;</span><span class="p">:</span> <span class="n">split_name</span><span class="p">,</span>
         <span class="p">}</span>
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;yolo&quot;</span><span class="p">:</span>
+        <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s2">&quot;dataset_fname&quot;</span><span class="p">:</span> <span class="n">dataset_fname</span><span class="p">,</span>
+            <span class="s2">&quot;dataset_dir&quot;</span><span class="p">:</span> <span class="n">dataset_dir</span><span class="p">,</span>
+        <span class="p">}</span>
+    <span class="k">elif</span> <span class="n">dataset_format</span> <span class="o">==</span> <span class="s2">&quot;nuimages&quot;</span><span class="p">:</span>
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">split</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;NuImages format currently supports only one split at a time&quot;</span><span class="p">)</span>
+        <span class="n">dataset_args</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s2">&quot;dataset_dir&quot;</span><span class="p">:</span> <span class="n">dataset_dir</span><span class="p">,</span>
+            <span class="s2">&quot;split&quot;</span><span class="p">:</span> <span class="n">split</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
+        <span class="p">}</span>
     <span class="k">else</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dataset format not supported: </span><span class="si">{</span><span class="n">dataset_format</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 

docs/py_docs/build/html/_modules/perceptionmetrics/cli.html

@@ -297,7 +297,19 @@ <h1>Source code for perceptionmetrics.cli.eval_model</h1><div class="highlight">
 <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span>
     <span class="s2">&quot;--dataset_format&quot;</span><span class="p">,</span>
     <span class="nb">type</span><span class="o">=</span><span class="n">click</span><span class="o">.</span><span class="n">Choice</span><span class="p">(</span>
-        <span class="p">[</span><span class="s2">&quot;gaia&quot;</span><span class="p">,</span> <span class="s2">&quot;rellis3d&quot;</span><span class="p">,</span> <span class="s2">&quot;goose&quot;</span><span class="p">,</span> <span class="s2">&quot;generic&quot;</span><span class="p">,</span> <span class="s2">&quot;rugd&quot;</span><span class="p">,</span> <span class="s2">&quot;coco&quot;</span><span class="p">],</span> <span class="n">case_sensitive</span><span class="o">=</span><span class="kc">False</span>
+        <span class="p">[</span>
+            <span class="s2">&quot;gaia&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;rellis3d&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;goose&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;generic&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;rugd&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;coco&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;cityscapes&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;nuimages&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;yolo&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;wildscenes&quot;</span><span class="p">,</span>
+        <span class="p">],</span>
+        <span class="n">case_sensitive</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
     <span class="p">),</span>
     <span class="n">show_default</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
     <span class="n">default</span><span class="o">=</span><span class="s2">&quot;gaia&quot;</span><span class="p">,</span>

docs/py_docs/build/html/_modules/perceptionmetrics/cli/eval_model.html

@@ -285,7 +285,18 @@ <h1>Source code for perceptionmetrics.cli.eval_preds</h1><div class="highlight">
 <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span>
     <span class="s2">&quot;--dataset_format&quot;</span><span class="p">,</span>
     <span class="nb">type</span><span class="o">=</span><span class="n">click</span><span class="o">.</span><span class="n">Choice</span><span class="p">(</span>
-        <span class="p">[</span><span class="s2">&quot;gaia&quot;</span><span class="p">,</span> <span class="s2">&quot;rellis3d&quot;</span><span class="p">,</span> <span class="s2">&quot;goose&quot;</span><span class="p">,</span> <span class="s2">&quot;generic&quot;</span><span class="p">,</span> <span class="s2">&quot;rugd&quot;</span><span class="p">,</span> <span class="s2">&quot;coco&quot;</span><span class="p">],</span>
+        <span class="p">[</span>
+            <span class="s2">&quot;gaia&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;rellis3d&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;goose&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;generic&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;rugd&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;coco&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;cityscapes&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;nuimages&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;yolo&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;wildscenes&quot;</span><span class="p">,</span>
+        <span class="p">],</span>
         <span class="n">case_sensitive</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
     <span class="p">),</span>
     <span class="n">show_default</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>