Deploying to gh-pages from @ 44e796a 🚀

README.md

@@ -6,9 +6,9 @@
 ![code style](https://img.shields.io/badge/code%20style-black-000000.svg)
 [![coverage](https://bioimage-io.github.io/core-bioimage-io-python/coverage/coverage-badge.svg)](https://bioimage-io.github.io/core-bioimage-io-python/coverage/index.html)
 
-# core-bioimage-io-python
+# bioimageio.core
 
-Python specific core utilities for bioimage.io resources (in particular models).
+Python specific core utilities for bioimage.io resources (in particular DL models).
 
 ## Get started
 

bioimageio/core.html

@@ -32,7 +32,7 @@
 
             <h2>Contents</h2>
             <ul>
-  <li><a href="#core-bioimage-io-python">core-bioimage-io-python</a>
+  <li><a href="#bioimageiocore">bioimageio.core</a>
   <ul>
     <li><a href="#get-started">Get started</a></li>
     <li><a href="#use-the-command-line-interface">💻 Use the Command Line Interface</a></li>
@@ -393,9 +393,9 @@ <h1 class="modulename">
 <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="code style" />
 <a href="https://bioimage-io.github.io/core-bioimage-io-python/coverage/index.html"><img src="https://bioimage-io.github.io/core-bioimage-io-python/coverage/coverage-badge.svg" alt="coverage" /></a></p>
 
-<h1 id="core-bioimage-io-python">core-bioimage-io-python</h1>
+<h1 id="bioimageiocore"><a href="">bioimageio.core</a></h1>
 
-<p>Python specific core utilities for bioimage.io resources (in particular models).</p>
+<p>Python specific core utilities for bioimage.io resources (in particular DL models).</p>
 
 <h2 id="get-started">Get started</h2>
 
@@ -1849,7 +1849,7 @@ <h6 id="returns">Returns:</h6>
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">compute_dataset_measures</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="n">measures</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n"><a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a></span><span class="p">],</span> <span class="n">Discriminator</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">custom_error_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_context</span><span class="o">=</span><span class="kc">None</span><span class="p">)]]</span>,</span><span class="param">	<span class="n">dataset</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n"><a href="#Sample">Sample</a></span><span class="p">]</span></span><span class="return-annotation">) -> <span class="n">Dict</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n"><a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a></span><span class="p">],</span> <span class="n">Discriminator</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">custom_error_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_context</span><span class="o">=</span><span class="kc">None</span><span class="p">)],</span> <span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">Annotated</span><span class="p">[</span><span class="n"><a href="#Tensor">Tensor</a></span><span class="p">,</span> <span class="n">BeforeValidator</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">tensor_custom_before_validator</span> <span class="n">at</span> <span class="mh">0x7f4647f7a840</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">json_schema_input_type</span><span class="o">=</span><span class="n">PydanticUndefined</span><span class="p">),</span> <span class="n">PlainSerializer</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">tensor_custom_serializer</span> <span class="n">at</span> <span class="mh">0x7f4647f7aa20</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">return_type</span><span class="o">=</span><span class="n">PydanticUndefined</span><span class="p">,</span> <span class="n">when_used</span><span class="o">=</span><span class="s1">&#39;always&#39;</span><span class="p">)]]]</span>:</span></span>
+        <span class="name">compute_dataset_measures</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="n">measures</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n"><a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a></span><span class="p">],</span> <span class="n">Discriminator</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">custom_error_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_context</span><span class="o">=</span><span class="kc">None</span><span class="p">)]]</span>,</span><span class="param">	<span class="n">dataset</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n"><a href="#Sample">Sample</a></span><span class="p">]</span></span><span class="return-annotation">) -> <span class="n">Dict</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n"><a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a></span><span class="p">,</span> <span class="n"><a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a></span><span class="p">],</span> <span class="n">Discriminator</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">custom_error_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_error_context</span><span class="o">=</span><span class="kc">None</span><span class="p">)],</span> <span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">Annotated</span><span class="p">[</span><span class="n"><a href="#Tensor">Tensor</a></span><span class="p">,</span> <span class="n">BeforeValidator</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">tensor_custom_before_validator</span> <span class="n">at</span> <span class="mh">0x7f1c4fafe840</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">json_schema_input_type</span><span class="o">=</span><span class="n">PydanticUndefined</span><span class="p">),</span> <span class="n">PlainSerializer</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">tensor_custom_serializer</span> <span class="n">at</span> <span class="mh">0x7f1c4fafea20</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">return_type</span><span class="o">=</span><span class="n">PydanticUndefined</span><span class="p">,</span> <span class="n">when_used</span><span class="o">=</span><span class="s1">&#39;always&#39;</span><span class="p">)]]]</span>:</span></span>
 
                 <label class="view-source-button" for="compute_dataset_measures-view-source"><span>View Source</span></label>
 
@@ -3642,7 +3642,7 @@ <h6 id="arguments">Arguments:</h6>
                             </div>
                             <div id="Sample.stat" class="classattr">
                                 <div class="attr variable">
-            <span class="name">stat</span><span class="annotation">: Dict[Annotated[Union[Annotated[Union[<a href="core/stat_measures.html#SampleMean">bioimageio.core.stat_measures.SampleMean</a>, <a href="core/stat_measures.html#SampleStd">bioimageio.core.stat_measures.SampleStd</a>, <a href="core/stat_measures.html#SampleVar">bioimageio.core.stat_measures.SampleVar</a>, <a href="core/stat_measures.html#SampleQuantile">bioimageio.core.stat_measures.SampleQuantile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Annotated[Union[<a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a>, <a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a>, <a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a>, <a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)]], Discriminator(discriminator=&#39;scope&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Union[float, Annotated[<a href="#Tensor">Tensor</a>, BeforeValidator(func=&lt;function tensor_custom_before_validator at 0x7f4647f7a840&gt;, json_schema_input_type=PydanticUndefined), PlainSerializer(func=&lt;function tensor_custom_serializer at 0x7f4647f7aa20&gt;, return_type=PydanticUndefined, when_used=&#39;always&#39;)]]]</span>
+            <span class="name">stat</span><span class="annotation">: Dict[Annotated[Union[Annotated[Union[<a href="core/stat_measures.html#SampleMean">bioimageio.core.stat_measures.SampleMean</a>, <a href="core/stat_measures.html#SampleStd">bioimageio.core.stat_measures.SampleStd</a>, <a href="core/stat_measures.html#SampleVar">bioimageio.core.stat_measures.SampleVar</a>, <a href="core/stat_measures.html#SampleQuantile">bioimageio.core.stat_measures.SampleQuantile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Annotated[Union[<a href="core/stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a>, <a href="core/stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a>, <a href="core/stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a>, <a href="core/stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)]], Discriminator(discriminator=&#39;scope&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Union[float, Annotated[<a href="#Tensor">Tensor</a>, BeforeValidator(func=&lt;function tensor_custom_before_validator at 0x7f1c4fafe840&gt;, json_schema_input_type=PydanticUndefined), PlainSerializer(func=&lt;function tensor_custom_serializer at 0x7f1c4fafea20&gt;, return_type=PydanticUndefined, when_used=&#39;always&#39;)]]]</span>
 
 
     </div>

bioimageio/core/proc_ops.html

@@ -1068,7 +1068,7 @@ <h1 class="modulename">
                             </div>
                             <div id="AddKnownDatasetStats.dataset_stats" class="classattr">
                                 <div class="attr variable">
-            <span class="name">dataset_stats</span><span class="annotation">: Mapping[Annotated[Union[<a href="stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a>, <a href="stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a>, <a href="stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a>, <a href="stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Union[float, Annotated[<a href="../core.html#Tensor">bioimageio.core.Tensor</a>, BeforeValidator(func=&lt;function tensor_custom_before_validator at 0x7f4647f7a840&gt;, json_schema_input_type=PydanticUndefined), PlainSerializer(func=&lt;function tensor_custom_serializer at 0x7f4647f7aa20&gt;, return_type=PydanticUndefined, when_used=&#39;always&#39;)]]]</span>
+            <span class="name">dataset_stats</span><span class="annotation">: Mapping[Annotated[Union[<a href="stat_measures.html#DatasetMean">bioimageio.core.stat_measures.DatasetMean</a>, <a href="stat_measures.html#DatasetStd">bioimageio.core.stat_measures.DatasetStd</a>, <a href="stat_measures.html#DatasetVar">bioimageio.core.stat_measures.DatasetVar</a>, <a href="stat_measures.html#DatasetPercentile">bioimageio.core.stat_measures.DatasetPercentile</a>], Discriminator(discriminator=&#39;name&#39;, custom_error_type=None, custom_error_message=None, custom_error_context=None)], Union[float, Annotated[<a href="../core.html#Tensor">bioimageio.core.Tensor</a>, BeforeValidator(func=&lt;function tensor_custom_before_validator at 0x7f1c4fafe840&gt;, json_schema_input_type=PydanticUndefined), PlainSerializer(func=&lt;function tensor_custom_serializer at 0x7f1c4fafea20&gt;, return_type=PydanticUndefined, when_used=&#39;always&#39;)]]]</span>
 
 
     </div>