Deploying to gh-pages from @ a20e58b 🚀

bioimage-io · Oct 29, 2024 · 60e7496 · 60e7496
1 parent 08e39f1
commit 60e7496
Show file tree

Hide file tree

Showing 40 changed files with 891 additions and 899 deletions.
diff --git a/bioimageio/spec/_internal/common_nodes.html b/bioimageio/spec/_internal/common_nodes.html
@@ -1339,7 +1339,7 @@ <h5>Inherited Members</h5>
                             <div id="ResourceDescrBase.fields_to_set_explicitly" class="classattr">
                                 <div class="attr variable">
             <span class="name">fields_to_set_explicitly</span><span class="annotation">: ClassVar[FrozenSet[LiteralString]]</span>        =
-<span class="default_value">frozenset({&#39;format_version&#39;, &#39;type&#39;})</span>
+<span class="default_value">frozenset({&#39;type&#39;, &#39;format_version&#39;})</span>
 
 
     </div>

diff --git a/bioimageio/spec/_internal/constants.html b/bioimageio/spec/_internal/constants.html
@@ -248,7 +248,7 @@ <h1 class="modulename">
                     <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;ctr26&#39;, &#39;donglaiw&#39;, &#39;clementcaporal&#39;, &#39;lenkaback&#39;, &#39;esgomezm&#39;, &#39;jansanrom&#39;, &#39;ivanhcenalmor&#39;, &#39;aaitorg&#39;, &#39;danifranco&#39;, &#39;oeway&#39;, &#39;carlosuc3m&#39;, &#39;fynnbe&#39;, &#39;constantinpape&#39;, &#39;githubuser2&#39;, &#39;k-dominik&#39;, &#39;pedgomgal1&#39;, &#39;cfusterbarcelo&#39;, &#39;bioimageiobot&#39;, &#39;iarganda&#39;}</span>
+            <label class="view-value-button pdoc-button" for="KNOWN_GH_USERS-view-value"></label><span class="default_value">{&#39;cfusterbarcelo&#39;, &#39;donglaiw&#39;, &#39;aaitorg&#39;, &#39;oeway&#39;, &#39;lenkaback&#39;, &#39;esgomezm&#39;, &#39;fynnbe&#39;, &#39;danifranco&#39;, &#39;pedgomgal1&#39;, &#39;bioimageiobot&#39;, &#39;ivanhcenalmor&#39;, &#39;constantinpape&#39;, &#39;iarganda&#39;, &#39;k-dominik&#39;, &#39;jansanrom&#39;, &#39;githubuser2&#39;, &#39;clementcaporal&#39;, &#39;ctr26&#39;, &#39;carlosuc3m&#39;}</span>
 
 
     </div>

diff --git a/bioimageio/spec/_internal/io.html b/bioimageio/spec/_internal/io.html
@@ -2657,7 +2657,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[<a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="#RelativeFilePath">RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]</span>
+            <span class="name">source</span><span class="annotation">: Annotated[Union[<a href="url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="#RelativeFilePath">RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]</span>
 
 
     </div>

diff --git a/bioimageio/spec/application/v0_2.html b/bioimageio/spec/application/v0_2.html
@@ -266,7 +266,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="ApplicationDescr.source" class="classattr">
                                 <div class="attr variable">
-            <span class="name">source</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#39;URL or path to the source of the application&#39;)]</span>
+            <span class="name">source</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#39;URL or path to the source of the application&#39;)]</span>
 
 
     </div>

diff --git a/bioimageio/spec/application/v0_3.html b/bioimageio/spec/application/v0_3.html
@@ -281,7 +281,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="ApplicationDescr.source" class="classattr">
                                 <div class="attr variable">
-            <span class="name">source</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#39;URL or path to the source of the application&#39;)]</span>
+            <span class="name">source</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#39;URL or path to the source of the application&#39;)]</span>
 
 
     </div>

diff --git a/bioimageio/spec/generic/v0_2.html b/bioimageio/spec/generic/v0_2.html
@@ -980,7 +980,7 @@ <h1 class="modulename">
                             </div>
                             <div id="AttachmentsDescr.files" class="classattr">
                                 <div class="attr variable">
-            <span class="name">files</span><span class="annotation">: List[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]]</span>
+            <span class="name">files</span><span class="annotation">: List[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]]</span>
 
 
     </div>
@@ -1071,7 +1071,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="Uploader.name" class="classattr">
                                 <div class="attr variable">
-            <span class="name">name</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7f97c5ee68e0&gt;)]]</span>
+            <span class="name">name</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7fa75dc628e0&gt;)]]</span>
 
 
     </div>
@@ -1162,7 +1162,7 @@ <h5>Inherited Members</h5>
 
                             <div id="Author.name" class="classattr">
                                 <div class="attr variable">
-            <span class="name">name</span><span class="annotation">: Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7f97c5ee68e0&gt;)]</span>
+            <span class="name">name</span><span class="annotation">: Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7fa75dc628e0&gt;)]</span>
 
 
     </div>
@@ -1268,7 +1268,7 @@ <h5>Inherited Members</h5>
 
                             <div id="Maintainer.name" class="classattr">
                                 <div class="attr variable">
-            <span class="name">name</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7f97c5ee68e0&gt;)]]</span>
+            <span class="name">name</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=&lt;function _remove_slashes at 0x7fa75dc628e0&gt;)]]</span>
 
 
     </div>
@@ -1405,7 +1405,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="BadgeDescr.icon" class="classattr">
                                 <div class="attr variable">
-            <span class="name">icon</span><span class="annotation">: Annotated[Union[Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)], <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>], AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)], <a href="../_internal/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)], NoneType], FieldInfo(annotation=NoneType, required=True, examples=[&#39;https://colab.research.google.com/assets/colab-badge.svg&#39;])]</span>
+            <span class="name">icon</span><span class="annotation">: Annotated[Union[Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)], <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>], AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)], <a href="../_internal/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)], NoneType], FieldInfo(annotation=NoneType, required=True, examples=[&#39;https://colab.research.google.com/assets/colab-badge.svg&#39;])]</span>
 
 
     </div>
@@ -1949,7 +1949,7 @@ <h5>Inherited Members</h5>
 
                             <div id="GenericModelDescrBase.name" class="classattr">
                                 <div class="attr variable">
-            <span class="name">name</span><span class="annotation">: Annotated[str, MinLen(min_length=1), AfterWarner(func=&lt;function as_warning.&lt;locals&gt;.wrapper at 0x7f97c5f55d00&gt;, severity=30, msg=&#39;Longer than 128 characters.&#39;, context={&#39;typ&#39;: Annotated[Any, MaxLen(max_length=128)]})]</span>
+            <span class="name">name</span><span class="annotation">: Annotated[str, MinLen(min_length=1), AfterWarner(func=&lt;function as_warning.&lt;locals&gt;.wrapper at 0x7fa75dcd1d00&gt;, severity=30, msg=&#39;Longer than 128 characters.&#39;, context={&#39;typ&#39;: Annotated[Any, MaxLen(max_length=128)]})]</span>
 
 
     </div>
@@ -1973,7 +1973,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="GenericModelDescrBase.covers" class="classattr">
                                 <div class="attr variable">
-            <span class="name">covers</span><span class="annotation">: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;), Predicate(is_absolute)], <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, <a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), WithSuffix(suffix=(&#39;.gif&#39;, &#39;.jpeg&#39;, &#39;.jpg&#39;, &#39;.png&#39;, &#39;.svg&#39;, &#39;.tif&#39;, &#39;.tiff&#39;), case_sensitive=False), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#34;Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: (&#39;.gif&#39;, &#39;.jpeg&#39;, &#39;.jpg&#39;, &#39;.png&#39;, &#39;.svg&#39;, &#39;.tif&#39;, &#39;.tiff&#39;)&#34;, examples=[&#39;cover.png&#39;])]</span>
+            <span class="name">covers</span><span class="annotation">: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;), Predicate(is_absolute)], <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, <a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), WithSuffix(suffix=(&#39;.gif&#39;, &#39;.jpeg&#39;, &#39;.jpg&#39;, &#39;.png&#39;, &#39;.svg&#39;, &#39;.tif&#39;, &#39;.tiff&#39;), case_sensitive=False), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, description=&#34;Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: (&#39;.gif&#39;, &#39;.jpeg&#39;, &#39;.jpg&#39;, &#39;.png&#39;, &#39;.svg&#39;, &#39;.tif&#39;, &#39;.tiff&#39;)&#34;, examples=[&#39;cover.png&#39;])]</span>
 
 
     </div>
@@ -2130,7 +2130,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="GenericModelDescrBase.icon" class="classattr">
                                 <div class="attr variable">
-            <span class="name">icon</span><span class="annotation">: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)], NoneType]</span>
+            <span class="name">icon</span><span class="annotation">: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)], NoneType]</span>
 
 
     </div>
@@ -2480,7 +2480,7 @@ <h5>Inherited Members</h5>
                             </div>
                             <div id="GenericDescrBase.documentation" class="classattr">
                                 <div class="attr variable">
-            <span class="name">documentation</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7f97c5ea4400&gt;), PlainSerializer(func=&lt;function _package at 0x7f97c5ea5800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, examples=[&#39;https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md&#39;, &#39;README.md&#39;])]</span>
+            <span class="name">documentation</span><span class="annotation">: Annotated[Optional[Annotated[Union[<a href="../_internal/url.html#HttpUrl">bioimageio.spec._internal.url.HttpUrl</a>, <a href="../_internal/io.html#RelativeFilePath">bioimageio.spec._internal.io.RelativeFilePath</a>, Annotated[pathlib.Path, PathType(path_type=&#39;file&#39;)]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode=&#39;left_to_right&#39;)]), AfterValidator(func=&lt;function wo_special_file_name at 0x7fa75dc20400&gt;), PlainSerializer(func=&lt;function _package at 0x7fa75dc21800&gt;, return_type=PydanticUndefined, when_used=&#39;unless-none&#39;)]], FieldInfo(annotation=NoneType, required=True, examples=[&#39;https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md&#39;, &#39;README.md&#39;])]</span>
 
 
     </div>