Deploying to gh-pages from @ bf71654 🚀

README.md

@@ -228,6 +228,11 @@ Made with [contrib.rocks](https://contrib.rocks).
 
 ### Resource Description Format Versions
 
+#### model 0.5.1 (planned)
+
+* Non-breaking changes
+  * added optional `inputs.i.optional` field to indicate that a tensor may be `None`
+
 #### generic 0.3.0 / application 0.3.0 / collection 0.3.0 / dataset 0.3.0 / notebook 0.3.0
 
 * Breaking canges that are fully auto-convertible

bioimageio/spec.html

@@ -412,6 +412,15 @@ <h4 id="bioimageiospec-040post2"><a href="">bioimageio.spec</a> 0.4.0.post2</h4>
 
 <h3 id="resource-description-format-versions">Resource Description Format Versions</h3>
 
+<h4 id="model-051-planned">model 0.5.1 (planned)</h4>
+
+<ul>
+<li>Non-breaking changes
+<ul>
+<li>added optional <code>inputs.i.optional</code> field to indicate that a tensor may be <code>None</code></li>
+</ul></li>
+</ul>
+
 <h4 id="generic-030-application-030-collection-030-dataset-030-notebook-030">generic 0.3.0 / application 0.3.0 / collection 0.3.0 / dataset 0.3.0 / notebook 0.3.0</h4>
 
 <ul>

bioimageio/spec/_internal/constants.html

@@ -338,7 +338,7 @@ <h5>Inherited Members</h5>
                     <div class="attr variable">
             <span class="name">KNOWN_GH_USERS</span><span class="annotation">: Set[str]</span>        =
 <input id="KNOWN_GH_USERS-view-value" class="view-value-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
-            <label class="view-value-button pdoc-button" for="KNOWN_GH_USERS-view-value"></label><span class="default_value">{&#39;lenkaback&#39;, &#39;k-dominik&#39;, &#39;constantinpape&#39;, &#39;aaitorg&#39;, &#39;danifranco&#39;, &#39;bioimageiobot&#39;, &#39;ctr26&#39;, &#39;iarganda&#39;, &#39;donglaiw&#39;, &#39;esgomezm&#39;, &#39;fynnbe&#39;, &#39;jansanrom&#39;, &#39;clementcaporal&#39;, &#39;githubuser2&#39;, &#39;ivanhcenalmor&#39;, &#39;pedgomgal1&#39;, &#39;cfusterbarcelo&#39;, &#39;oeway&#39;, &#39;carlosuc3m&#39;}</span>
+            <label class="view-value-button pdoc-button" for="KNOWN_GH_USERS-view-value"></label><span class="default_value">{&#39;lenkaback&#39;, &#39;oeway&#39;, &#39;aaitorg&#39;, &#39;k-dominik&#39;, &#39;carlosuc3m&#39;, &#39;jansanrom&#39;, &#39;danifranco&#39;, &#39;donglaiw&#39;, &#39;githubuser2&#39;, &#39;esgomezm&#39;, &#39;bioimageiobot&#39;, &#39;pedgomgal1&#39;, &#39;ivanhcenalmor&#39;, &#39;fynnbe&#39;, &#39;clementcaporal&#39;, &#39;constantinpape&#39;, &#39;ctr26&#39;, &#39;cfusterbarcelo&#39;, &#39;iarganda&#39;}</span>
 
 
     </div>
@@ -362,7 +362,7 @@ <h5>Inherited Members</h5>
                 <section id="KNOWN_INVALID_GH_USERS">
                     <div class="attr variable">
             <span class="name">KNOWN_INVALID_GH_USERS</span><span class="annotation">: Set[str]</span>        =
-<span class="default_value">{&#39;arratemunoz&#39;, &#39;lmescu&#39;}</span>
+<span class="default_value">{&#39;lmescu&#39;, &#39;arratemunoz&#39;}</span>
 
 
     </div>

bioimageio/spec/_internal/io.html

@@ -1237,7 +1237,7 @@ <h5>Inherited Members</h5>
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;file&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7afca4145940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;dir&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7afca4145940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
+        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;file&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7a1b66b49940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;dir&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7a1b66b49940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
 
                 <label class="view-source-button" for="RelativePath.get_absolute-view-source"><span>View Source</span></label>
 
@@ -1355,7 +1355,7 @@ <h5>Inherited Members</h5>
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;file&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7afca4145940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
+        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;file&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7a1b66b49940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
 
                 <label class="view-source-button" for="RelativeFilePath.get_absolute-view-source"><span>View Source</span></label>
 
@@ -1475,7 +1475,7 @@ <h5>Inherited Members</h5>
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;dir&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7afca4145940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
+        <span class="name">get_absolute</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">root</span><span class="p">:</span> <span class="n"><a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a></span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="n">pydantic_core</span><span class="o">.</span><span class="n">_pydantic_core</span><span class="o">.</span><span class="n">Url</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="n">Annotated</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">PathType</span><span class="p">(</span><span class="n">path_type</span><span class="o">=</span><span class="s1">&#39;dir&#39;</span><span class="p">),</span> <span class="n">Predicate</span><span class="p">(</span><span class="n">func</span><span class="o">=&lt;</span><span class="n">function</span> <span class="n">PurePath</span><span class="o">.</span><span class="n">is_absolute</span> <span class="n">at</span> <span class="mh">0x7a1b66b49940</span><span class="o">&gt;</span><span class="p">)],</span> <span class="n"><a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a></span><span class="p">]</span>:</span></span>
 
                 <label class="view-source-button" for="RelativeDirectory.get_absolute-view-source"><span>View Source</span></label>
 
@@ -1997,7 +1997,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="OpenedBioimageioYaml.original_root" class="classattr">
                                 <div class="attr variable">
-            <span class="name">original_root</span><span class="annotation">: Union[Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7afca4145940&gt;)], <a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>]</span>
+            <span class="name">original_root</span><span class="annotation">: Union[Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7a1b66b49940&gt;)], <a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>]</span>
 
 
     </div>
@@ -2065,7 +2065,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="DownloadedFile.original_root" class="classattr">
                                 <div class="attr variable">
-            <span class="name">original_root</span><span class="annotation">: Union[Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7afca4145940&gt;)], <a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>]</span>
+            <span class="name">original_root</span><span class="annotation">: Union[Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7a1b66b49940&gt;)], <a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>]</span>
 
 
     </div>
@@ -2284,7 +2284,7 @@ <h5>Inherited Members</h5>
 
                             <div id="FileDescr.source" class="classattr">
                                 <div class="attr variable">
-            <span class="name">source</span><span class="annotation">: Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)], <a href="#RelativeFilePath">RelativeFilePath</a>, <a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=[&#39;http&#39;, &#39;https&#39;], host_required=None, default_host=None, default_port=None, default_path=None)]], AfterValidator(func=&lt;function wo_special_file_name at 0x7afca0d90540&gt;), PlainSerializer(func=&lt;function _package at 0x7afca0d91760&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]</span>
+            <span class="name">source</span><span class="annotation">: Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)], <a href="#RelativeFilePath">RelativeFilePath</a>, <a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=[&#39;http&#39;, &#39;https&#39;], host_required=None, default_host=None, default_port=None, default_path=None)]], AfterValidator(func=&lt;function wo_special_file_name at 0x7a1b63520540&gt;), PlainSerializer(func=&lt;function _package at 0x7a1b63521760&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]</span>
 
 
     </div>

bioimageio/spec/_internal/packaging_context.html

@@ -207,7 +207,7 @@ <h1 class="modulename">
                             </div>
                             <div id="PackagingContext.file_sources" class="classattr">
                                 <div class="attr variable">
-            <span class="name">file_sources</span><span class="annotation">: Dict[str, Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7afca4145940&gt;)], <a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>]]</span>
+            <span class="name">file_sources</span><span class="annotation">: Dict[str, Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7a1b66b49940&gt;)], <a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>]]</span>
 
 
     </div>

bioimageio/spec/_internal/validation_context.html

@@ -294,7 +294,7 @@ <h1 class="modulename">
                             </div>
                             <div id="ValidationContext.root" class="classattr">
                                 <div class="attr variable">
-            <span class="name">root</span><span class="annotation">: Union[<a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>, Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7afca4145940&gt;)]]</span>        =
+            <span class="name">root</span><span class="annotation">: Union[<a href="root_url.html#RootHttpUrl">bioimageio.spec._internal.root_url.RootHttpUrl</a>, Annotated[pathlib.Path, PathType(path_type=&#39;dir&#39;), Predicate(func=&lt;function PurePath.is_absolute at 0x7a1b66b49940&gt;)]]</span>        =
 <span class="default_value">PosixPath(&#39;.&#39;)</span>