From 12233241235e2fbc74c2d002a7b2f32b1408f306 Mon Sep 17 00:00:00 2001 From: FynnBe Date: Tue, 12 Nov 2024 08:40:20 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20bioimage?= =?UTF-8?q?-io/spec-bioimage-io@e77a24d95eeddce13bb3fa8490c59954090e3655?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- bioimageio/spec.html | 10 ++--- bioimageio/spec/application.html | 2 +- bioimageio/spec/application/v0_2.html | 2 +- bioimageio/spec/application/v0_3.html | 2 +- bioimageio/spec/common.html | 2 +- bioimageio/spec/generic/v0_2.html | 18 ++++----- bioimageio/spec/generic/v0_3.html | 14 +++---- bioimageio/spec/model.html | 8 ++-- bioimageio/spec/model/v0_4.html | 40 +++++++++---------- bioimageio/spec/model/v0_5.html | 16 ++++---- bioimageio_schema_latest.json | 2 +- bioimageio_schema_latest/index.html | 4 +- bioimageio_schema_v0-5.json | 2 +- bioimageio_schema_v0-5/index.html | 4 +- coverage/class_index.html | 4 +- coverage/function_index.html | 4 +- coverage/index.html | 4 +- coverage/z_0703eb9a8d100bed___init___py.html | 4 +- coverage/z_7c461fd3866d8843___init___py.html | 4 +- ...z_7c461fd3866d8843__v0_2_converter_py.html | 4 +- ...z_7c461fd3866d8843__v0_3_converter_py.html | 4 +- coverage/z_7c461fd3866d8843_v0_2_py.html | 4 +- coverage/z_7c461fd3866d8843_v0_3_py.html | 4 +- coverage/z_85344614e6dfc2bc___init___py.html | 4 +- coverage/z_85344614e6dfc2bc_v0_2_py.html | 4 +- coverage/z_85344614e6dfc2bc_v0_3_py.html | 4 +- coverage/z_8b355a6314ca24cb___init___py.html | 4 +- coverage/z_8b355a6314ca24cb_v0_2_py.html | 4 +- coverage/z_8b355a6314ca24cb_v0_3_py.html | 4 +- coverage/z_aa900e9bba511ebd___init___py.html | 4 +- .../z_aa900e9bba511ebd__plugin_parser_py.html | 4 +- coverage/z_c0dbdc82d7fcf101___init___py.html | 4 +- ...1__generated_spdx_license_literals_py.html | 4 +- coverage/z_c0dbdc82d7fcf101__settings_py.html | 4 +- .../z_c0dbdc82d7fcf101_common_nodes_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_constants_py.html | 4 +- .../z_c0dbdc82d7fcf101_docs_utils_py.html | 4 +- ..._c0dbdc82d7fcf101_field_validation_py.html | 4 +- .../z_c0dbdc82d7fcf101_field_warning_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_gh_utils_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_io_basics_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_io_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_io_utils_py.html | 4 +- .../z_c0dbdc82d7fcf101_license_id_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_node_py.html | 4 +- ...c0dbdc82d7fcf101_packaging_context_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_root_url_py.html | 4 +- .../z_c0dbdc82d7fcf101_type_guards_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_types_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_url_py.html | 4 +- coverage/z_c0dbdc82d7fcf101_utils_py.html | 4 +- ..._c0dbdc82d7fcf101_validated_string_py.html | 4 +- ...0dbdc82d7fcf101_validation_context_py.html | 4 +- ...dc82d7fcf101_validator_annotations_py.html | 4 +- .../z_c0dbdc82d7fcf101_version_type_py.html | 4 +- .../z_c0dbdc82d7fcf101_warning_levels_py.html | 4 +- coverage/z_c34ff740b8e368f0___init___py.html | 4 +- ...z_c34ff740b8e368f0__v0_3_converter_py.html | 4 +- ...z_c34ff740b8e368f0__v0_4_converter_py.html | 4 +- coverage/z_c34ff740b8e368f0_v0_4_py.html | 4 +- coverage/z_c34ff740b8e368f0_v0_5_py.html | 4 +- coverage/z_ce3c5a97bba63cf5___init___py.html | 4 +- coverage/z_ce3c5a97bba63cf5_v0_2_py.html | 4 +- coverage/z_ce3c5a97bba63cf5_v0_3_py.html | 4 +- coverage/z_e55904ddcc61ab86___init___py.html | 4 +- ...e55904ddcc61ab86__description_impl_py.html | 4 +- .../z_e55904ddcc61ab86__description_py.html | 4 +- coverage/z_e55904ddcc61ab86__io_py.html | 4 +- coverage/z_e55904ddcc61ab86__package_py.html | 4 +- coverage/z_e55904ddcc61ab86_common_py.html | 4 +- coverage/z_e55904ddcc61ab86_conda_env_py.html | 4 +- .../z_e55904ddcc61ab86_get_conda_env_py.html | 4 +- ...dcc61ab86_pretty_validation_errors_py.html | 4 +- coverage/z_e55904ddcc61ab86_summary_py.html | 4 +- coverage/z_e55904ddcc61ab86_utils_py.html | 4 +- interactive_docs_v0-5.html | 14 +++---- search.js | 2 +- user_docs/application_descr_latest.md | 10 ++--- user_docs/application_descr_v0-2-4.md | 12 +++--- user_docs/application_descr_v0-2.md | 12 +++--- user_docs/application_descr_v0-3-0.md | 10 ++--- user_docs/application_descr_v0-3.md | 10 ++--- user_docs/dataset_descr_latest.md | 8 ++-- user_docs/dataset_descr_v0-2-4.md | 10 ++--- user_docs/dataset_descr_v0-2.md | 10 ++--- user_docs/dataset_descr_v0-3-0.md | 8 ++-- user_docs/dataset_descr_v0-3.md | 8 ++-- user_docs/generic_descr_latest.md | 8 ++-- user_docs/generic_descr_v0-2-4.md | 10 ++--- user_docs/generic_descr_v0-2.md | 10 ++--- user_docs/generic_descr_v0-3-0.md | 8 ++-- user_docs/generic_descr_v0-3.md | 8 ++-- user_docs/model_descr_latest.md | 28 ++++++------- user_docs/model_descr_v0-4-10.md | 36 ++++++++--------- user_docs/model_descr_v0-4.md | 36 ++++++++--------- user_docs/model_descr_v0-5-3.md | 28 ++++++------- user_docs/model_descr_v0-5.md | 28 ++++++------- user_docs/notebook_descr_latest.md | 8 ++-- user_docs/notebook_descr_v0-2-4.md | 10 ++--- user_docs/notebook_descr_v0-2.md | 10 ++--- user_docs/notebook_descr_v0-3-0.md | 8 ++-- user_docs/notebook_descr_v0-3.md | 8 ++-- 102 files changed, 364 insertions(+), 364 deletions(-) diff --git a/bioimageio/spec.html b/bioimageio/spec.html index 01013579a..9abf9a140 100644 --- a/bioimageio/spec.html +++ b/bioimageio/spec.html @@ -1507,7 +1507,7 @@

model 0.3.2

- source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')] + source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')]
@@ -3196,7 +3196,7 @@
Returns:
- documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f98c57cf560>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f637e3cf560>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
@@ -3225,7 +3225,7 @@
Returns:
- name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bb49a840>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})] + name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6373b9a840>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})]
@@ -3281,7 +3281,7 @@
Returns:
- run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bb49aca0>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})] + run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6373b9aca0>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})]
@@ -3324,7 +3324,7 @@
Returns:
- weights: Annotated[bioimageio.spec.model.v0_5.WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f98bc1a9e40>, return_type=PydanticUndefined, when_used='always')] + weights: Annotated[bioimageio.spec.model.v0_5.WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f63748a5e40>, return_type=PydanticUndefined, when_used='always')]
diff --git a/bioimageio/spec/application.html b/bioimageio/spec/application.html index f099bdd34..77e5c5cc1 100644 --- a/bioimageio/spec/application.html +++ b/bioimageio/spec/application.html @@ -202,7 +202,7 @@

- source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')] + source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')]
diff --git a/bioimageio/spec/application/v0_2.html b/bioimageio/spec/application/v0_2.html index 7f2a81282..b442cde11 100644 --- a/bioimageio/spec/application/v0_2.html +++ b/bioimageio/spec/application/v0_2.html @@ -248,7 +248,7 @@
Inherited Members
- source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')] + source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')]
diff --git a/bioimageio/spec/application/v0_3.html b/bioimageio/spec/application/v0_3.html index f1c1ea861..066027d6c 100644 --- a/bioimageio/spec/application/v0_3.html +++ b/bioimageio/spec/application/v0_3.html @@ -265,7 +265,7 @@
Inherited Members
- source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')] + source: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description='URL or path to the source of the application')]
diff --git a/bioimageio/spec/common.html b/bioimageio/spec/common.html index e5c738b35..730597468 100644 --- a/bioimageio/spec/common.html +++ b/bioimageio/spec/common.html @@ -335,7 +335,7 @@

- source: Annotated[Union[HttpUrl, RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[HttpUrl, RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
diff --git a/bioimageio/spec/generic/v0_2.html b/bioimageio/spec/generic/v0_2.html index 1d97dcdee..78987facc 100644 --- a/bioimageio/spec/generic/v0_2.html +++ b/bioimageio/spec/generic/v0_2.html @@ -893,7 +893,7 @@

- files: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]] + files: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]]
@@ -943,7 +943,7 @@

- name: Optional[Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f98c57cf380>)]] + name: Optional[Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f637e3cf380>)]]
@@ -978,7 +978,7 @@

- name: Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f98c57cf380>)] + name: Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f637e3cf380>)]
@@ -1033,7 +1033,7 @@
Inherited Members
- name: Optional[Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f98c57cf380>)]] + name: Optional[Annotated[str, AfterValidator(func=<function _remove_slashes at 0x7f637e3cf380>)]]
@@ -1119,7 +1119,7 @@
Inherited Members
- icon: Annotated[Union[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file')], bioimageio.spec._internal.io.RelativeFilePath], AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')], bioimageio.spec._internal.url.HttpUrl, Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)], NoneType], FieldInfo(annotation=NoneType, required=True, examples=['https://colab.research.google.com/assets/colab-badge.svg'])] + icon: Annotated[Union[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file')], bioimageio.spec._internal.io.RelativeFilePath], AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')], bioimageio.spec._internal.url.HttpUrl, Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)], NoneType], FieldInfo(annotation=NoneType, required=True, examples=['https://colab.research.google.com/assets/colab-badge.svg'])]
@@ -1495,7 +1495,7 @@
Inherited Members
- name: Annotated[str, MinLen(min_length=1), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bc359e40>, severity=30, msg='Longer than 128 characters.', context={'typ': Annotated[Any, MaxLen(max_length=128)]})] + name: Annotated[str, MinLen(min_length=1), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f637dd59e40>, severity=30, msg='Longer than 128 characters.', context={'typ': Annotated[Any, MaxLen(max_length=128)]})]
@@ -1519,7 +1519,7 @@
Inherited Members
- covers: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), WithSuffix(suffix=('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff'), case_sensitive=False), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description="Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')", examples=['cover.png'])] + covers: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), WithSuffix(suffix=('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff'), case_sensitive=False), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description="Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')", examples=['cover.png'])]
@@ -1676,7 +1676,7 @@
Inherited Members
- icon: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')], NoneType] + icon: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')], NoneType]
@@ -1952,7 +1952,7 @@
Inherited Members
- documentation: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Optional[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
diff --git a/bioimageio/spec/generic/v0_3.html b/bioimageio/spec/generic/v0_3.html index 4efee318e..730e991e9 100644 --- a/bioimageio/spec/generic/v0_3.html +++ b/bioimageio/spec/generic/v0_3.html @@ -823,7 +823,7 @@

- name: Annotated[str, Predicate(func=<function _has_no_slash at 0x7f98bc27a980>)] + name: Annotated[str, Predicate(func=<function _has_no_slash at 0x7f6374976980>)]
@@ -882,7 +882,7 @@
Inherited Members
- name: Optional[Annotated[str, Predicate(func=<function _has_no_slash at 0x7f98bc27a980>)]] + name: Optional[Annotated[str, Predicate(func=<function _has_no_slash at 0x7f6374976980>)]]
@@ -1265,7 +1265,7 @@
Inherited Members
- description: Annotated[str, MaxLen(max_length=1024), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba6f7380>, severity=30, msg='Description longer than 512 characters.', context={'typ': Annotated[Any, MaxLen(max_length=512)]})] + description: Annotated[str, MaxLen(max_length=1024), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372dfb380>, severity=30, msg='Description longer than 512 characters.', context={'typ': Annotated[Any, MaxLen(max_length=512)]})]
@@ -1278,7 +1278,7 @@
Inherited Members
- covers: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), WithSuffix(suffix=('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff'), case_sensitive=False), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description="Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')", examples=[])] + covers: Annotated[List[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), WithSuffix(suffix=('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff'), case_sensitive=False), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, description="Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')", examples=[])]
@@ -1343,7 +1343,7 @@
Inherited Members
- license: Annotated[Union[bioimageio.spec._internal.license_id.LicenseId, bioimageio.spec._internal.license_id.DeprecatedLicenseId], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba6f7100>, severity=30, msg='{value} is deprecated, see https://spdx.org/licenses/{value}.html', context={'typ': <class 'bioimageio.spec._internal.license_id.LicenseId'>}), FieldInfo(annotation=NoneType, required=True, examples=['CC0-1.0', 'MIT', 'BSD-2-Clause'])] + license: Annotated[Union[bioimageio.spec._internal.license_id.LicenseId, bioimageio.spec._internal.license_id.DeprecatedLicenseId], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372dfb100>, severity=30, msg='{value} is deprecated, see https://spdx.org/licenses/{value}.html', context={'typ': <class 'bioimageio.spec._internal.license_id.LicenseId'>}), FieldInfo(annotation=NoneType, required=True, examples=['CC0-1.0', 'MIT', 'BSD-2-Clause'])]
@@ -1405,7 +1405,7 @@
Inherited Members
- icon: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')], NoneType] + icon: Union[Annotated[str, Len(min_length=1, max_length=2)], Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')], NoneType]
@@ -1628,7 +1628,7 @@
Inherited Members
- documentation: Annotated[Optional[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f98c57cf560>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Optional[Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f637e3cf560>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]], FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
diff --git a/bioimageio/spec/model.html b/bioimageio/spec/model.html index dc85b585c..decb7f1f1 100644 --- a/bioimageio/spec/model.html +++ b/bioimageio/spec/model.html @@ -801,7 +801,7 @@

- documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f98c57cf560>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f637e3cf560>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
@@ -830,7 +830,7 @@

- name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bba4f100>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})] + name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f637414b100>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})]
@@ -886,7 +886,7 @@

- run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bba4eb60>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})] + run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f637414ab60>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})]
@@ -929,7 +929,7 @@

- weights: Annotated[bioimageio.spec.model.v0_5.WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f98bc1a9e40>, return_type=PydanticUndefined, when_used='always')] + weights: Annotated[bioimageio.spec.model.v0_5.WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f63748a5e40>, return_type=PydanticUndefined, when_used='always')]
diff --git a/bioimageio/spec/model/v0_4.html b/bioimageio/spec/model/v0_4.html index 7676552c5..10b9fb315 100644 --- a/bioimageio/spec/model/v0_4.html +++ b/bioimageio/spec/model/v0_4.html @@ -2135,7 +2135,7 @@
Inherited Members
- source_file: Annotated[Union[bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source_file: Annotated[Union[bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -2221,7 +2221,7 @@
Inherited Members
- file: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['environment.yaml', 'pom.xml', 'requirements.txt'])] + file: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['environment.yaml', 'pom.xml', 'requirements.txt'])]
@@ -2486,7 +2486,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -2499,7 +2499,7 @@
Inherited Members
- attachments: Annotated[Optional[bioimageio.spec.generic.v0_2.AttachmentsDescr], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba6f6980>, severity=35, msg='Weights entry depends on additional attachments.', context={'typ': None})] + attachments: Annotated[Optional[bioimageio.spec.generic.v0_2.AttachmentsDescr], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372dfa980>, severity=35, msg='Weights entry depends on additional attachments.', context={'typ': None})]
@@ -2529,7 +2529,7 @@
Inherited Members
- dependencies: Annotated[Optional[Dependencies], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bba4e700>, severity=30, msg='Custom dependencies ({value}) specified. Avoid this whenever possible to allow execution in a wider range of software environments.', context={'typ': None}), FieldInfo(annotation=NoneType, required=True, examples=['conda:environment.yaml', 'maven:./pom.xml', 'pip:./requirements.txt'])] + dependencies: Annotated[Optional[Dependencies], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f637414a700>, severity=30, msg='Custom dependencies ({value}) specified. Avoid this whenever possible to allow execution in a wider range of software environments.', context={'typ': None}), FieldInfo(annotation=NoneType, required=True, examples=['conda:environment.yaml', 'maven:./pom.xml', 'pip:./requirements.txt'])]
@@ -3132,7 +3132,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -3520,7 +3520,7 @@
Inherited Members
- axes: Annotated[str, RestrictCharacters(alphabet='bitczyx'), AfterValidator(func=<function validate_unique_entries at 0x7f98bc35b920>)] + axes: Annotated[str, RestrictCharacters(alphabet='bitczyx'), AfterValidator(func=<function validate_unique_entries at 0x7f637dd5b920>)]
@@ -3892,7 +3892,7 @@
Inherited Members
- axes: Annotated[Optional[Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f98bc35b920>)]], FieldInfo(annotation=NoneType, required=True, examples=['xy'])] + axes: Annotated[Optional[Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f637dd5b920>)]], FieldInfo(annotation=NoneType, required=True, examples=['xy'])]
@@ -4182,7 +4182,7 @@
Inherited Members
- axes: Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f98bc35b920>), FieldInfo(annotation=NoneType, required=True, examples=['xy'])] + axes: Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f637dd5b920>), FieldInfo(annotation=NoneType, required=True, examples=['xy'])]
@@ -4408,7 +4408,7 @@
Inherited Members
- axes: Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f98bc35b920>), FieldInfo(annotation=NoneType, required=True, examples=['xy'])] + axes: Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f637dd5b920>), FieldInfo(annotation=NoneType, required=True, examples=['xy'])]
@@ -4647,7 +4647,7 @@
Inherited Members
- axes: Annotated[Optional[Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f98bc35b920>)]], FieldInfo(annotation=NoneType, required=True, examples=['xy'])] + axes: Annotated[Optional[Annotated[str, RestrictCharacters(alphabet='czyx'), AfterValidator(func=<function validate_unique_entries at 0x7f637dd5b920>)]], FieldInfo(annotation=NoneType, required=True, examples=['xy'])]
@@ -5185,7 +5185,7 @@
Inherited Members
- name: Annotated[Union[Literal['deepimagej'], str], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bba4f060>, severity=30, msg="Unknown run mode '{value}'.", context={'typ': Literal['deepimagej']})] + name: Annotated[Union[Literal['deepimagej'], str], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f637414b060>, severity=30, msg="Unknown run mode '{value}'.", context={'typ': Literal['deepimagej']})]
@@ -5649,7 +5649,7 @@
Inherited Members
- documentation: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
@@ -5678,7 +5678,7 @@
Inherited Members
- license: Annotated[Union[bioimageio.spec._internal.license_id.LicenseId, str], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bab2f420>, severity=30, msg="Unknown license id '{value}'.", context={'typ': <class 'bioimageio.spec._internal.license_id.LicenseId'>}), FieldInfo(annotation=NoneType, required=True, examples=['CC0-1.0', 'MIT', 'BSD-2-Clause'])] + license: Annotated[Union[bioimageio.spec._internal.license_id.LicenseId, str], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6373233420>, severity=30, msg="Unknown license id '{value}'.", context={'typ': <class 'bioimageio.spec._internal.license_id.LicenseId'>}), FieldInfo(annotation=NoneType, required=True, examples=['CC0-1.0', 'MIT', 'BSD-2-Clause'])]
@@ -5694,7 +5694,7 @@
Inherited Members
- name: Annotated[str, MinLen(min_length=1), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98bab2f1a0>, severity=20, msg='Name shorter than 5 characters.', context={'typ': Annotated[Any, MinLen(min_length=5)]}), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba98afc0>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})] + name: Annotated[str, MinLen(min_length=1), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f63732331a0>, severity=20, msg='Name shorter than 5 characters.', context={'typ': Annotated[Any, MinLen(min_length=5)]}), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372e0efc0>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})]
@@ -5971,7 +5971,7 @@
Inherited Members
- sample_inputs: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]] + sample_inputs: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]]
@@ -5986,7 +5986,7 @@
Inherited Members
- sample_outputs: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')]] + sample_outputs: List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]]
@@ -5999,7 +5999,7 @@
Inherited Members
- test_inputs: Annotated[List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix='.npy', case_sensitive=True)]], MinLen(min_length=1)] + test_inputs: Annotated[List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix='.npy', case_sensitive=True)]], MinLen(min_length=1)]
@@ -6016,7 +6016,7 @@
Inherited Members
- test_outputs: Annotated[List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix='.npy', case_sensitive=True)]], MinLen(min_length=1)] + test_outputs: Annotated[List[Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix='.npy', case_sensitive=True)]], MinLen(min_length=1)]
@@ -6056,7 +6056,7 @@
Inherited Members
- weights: Annotated[WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f98bc1a9e40>, return_type=PydanticUndefined, when_used='always')] + weights: Annotated[WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f63748a5e40>, return_type=PydanticUndefined, when_used='always')]
diff --git a/bioimageio/spec/model/v0_5.html b/bioimageio/spec/model/v0_5.html index d1424d44a..d9a2274c4 100644 --- a/bioimageio/spec/model/v0_5.html +++ b/bioimageio/spec/model/v0_5.html @@ -8334,7 +8334,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix=('.yaml', '.yml'), case_sensitive=True), FieldInfo(annotation=NoneType, required=True, examples=['environment.yaml'])] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), WithSuffix(suffix=('.yaml', '.yml'), case_sensitive=True), FieldInfo(annotation=NoneType, required=True, examples=['environment.yaml'])]
@@ -8513,7 +8513,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -8903,7 +8903,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -9011,7 +9011,7 @@
Inherited Members
- source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f98c8013ce0>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none')] + source: Annotated[Union[bioimageio.spec._internal.url.HttpUrl, bioimageio.spec._internal.io.RelativeFilePath, Annotated[pathlib.Path, PathType(path_type='file')]], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function wo_special_file_name at 0x7f63806efce0>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none')]
@@ -9996,7 +9996,7 @@
Inherited Members
- documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f98c57cf560>), PlainSerializer(func=<function _package at 0x7f98c7e4c4a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])] + documentation: Annotated[Union[Annotated[pathlib.Path, PathType(path_type='file'), Predicate(is_absolute)], bioimageio.spec._internal.io.RelativeFilePath, bioimageio.spec._internal.url.HttpUrl], FieldInfo(annotation=NoneType, required=True, metadata=[_PydanticGeneralMetadata(union_mode='left_to_right')]), AfterValidator(func=<function _validate_md_suffix at 0x7f637e3cf560>), PlainSerializer(func=<function _package at 0x7f63805244a0>, return_type=PydanticUndefined, when_used='unless-none'), FieldInfo(annotation=NoneType, required=True, examples=['https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md', 'README.md'])]
@@ -10025,7 +10025,7 @@
Inherited Members
- name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba989800>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})] + name: Annotated[str, RestrictCharacters(alphabet='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_- ()'), MinLen(min_length=5), MaxLen(max_length=128), AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372e0d800>, severity=20, msg='Name longer than 64 characters.', context={'typ': Annotated[Any, MaxLen(max_length=64)]})]
@@ -10081,7 +10081,7 @@
Inherited Members
- run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f98ba6f59e0>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})] + run_mode: Annotated[Optional[bioimageio.spec.model.v0_4.RunMode], AfterWarner(func=<function as_warning.<locals>.wrapper at 0x7f6372df99e0>, severity=30, msg="Run mode '{value}' has limited support across consumer softwares.", context={'typ': None})]
@@ -10124,7 +10124,7 @@
Inherited Members
- weights: Annotated[WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f98bc1a9e40>, return_type=PydanticUndefined, when_used='always')] + weights: Annotated[WeightsDescr, WrapSerializer(func=<function package_weights at 0x7f63748a5e40>, return_type=PydanticUndefined, when_used='always')]
diff --git a/bioimageio_schema_latest.json b/bioimageio_schema_latest.json index 5f560a3cc..62f3f16fd 100644 --- a/bioimageio_schema_latest.json +++ b/bioimageio_schema_latest.json @@ -6067,7 +6067,7 @@ }, "timestamp": { "$ref": "#/$defs/Datetime", - "default": "2024-11-11T21:46:37.480437", + "default": "2024-11-12T08:39:49.618269", "description": "Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).\n(In Python a datetime object is valid, too)." }, "training_data": { diff --git a/bioimageio_schema_latest/index.html b/bioimageio_schema_latest/index.html index 15017d092..dcf1f5eb5 100644 --- a/bioimageio_schema_latest/index.html +++ b/bioimageio_schema_latest/index.html @@ -378,7 +378,7 @@

root oneOf item 2 oneOf bioimage.io model specification outputs OutputTensorDescr postprocessing postprocessing items oneOf ScaleMeanVarianceDescr kwargs eps

Eps

Type: number Default: 1e-06

Epsilon for numeric stability:
out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.

Value must be strictly greater than 0.0 and lesser or equal to 0.1

root oneOf item 2 oneOf bioimage.io model specification packaged_by

Packaged By

Type: array

The persons that have packaged and uploaded this model.
Only required if those persons differ from the authors.

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification packaged_by Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification packaged_by Author orcid

Orcid

Default: null

An ORCID iD in hyphenated groups of 4 digits, (and valid as per ISO 7064 11,2.)
Example:

0000-0001-2345-6789
-

root oneOf item 2 oneOf bioimage.io model specification parent
Default: null

The model from which this model is derived, e.g. by fine-tuning the weights.

root oneOf item 2 oneOf bioimage.io model specification parent anyOf bioimageio__spec__model__v0_5__LinkedModel
Type: object

Reference to a bioimage.io model.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent anyOf LinkedModel id

Id

Type: string

A valid model id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification parent anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification run_mode
Default: null

Custom run mode for this model: for more complex prediction procedures like test time
data augmentation that currently cannot be expressed in the specification.
No standard run modes are defined yet.

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode kwargs

Kwargs

Type: object

Run mode specific key word arguments
root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification timestamp
Type: string Default: "2024-11-11T21:46:37.480437"

Timestamp in ISO 8601 format
with a few restrictions listed here.
(In Python a datetime object is valid, too).

root oneOf item 2 oneOf bioimage.io model specification training_data

Training Data

Default: null

The dataset used to train this model

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__LinkedDataset
Type: object

Reference to a bioimage.io dataset.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf LinkedDataset id

Id

Type: string

A valid dataset id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__DatasetDescr
Type: object

A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage
processing.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification name

Name

Type: string

A human-friendly name of the resource description.
May only contains letters, digits, underscore, minus, parentheses and spaces.

Must be at least 1 characters long

Must be at most 128 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification description

Description

Type: string

A string containing a brief description.

Must be at most 1024 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers

Covers

Type: array

Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.
The supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers covers items

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors

Authors

Type: array

The authors are the creators of this resource description and the primary points of contact.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent
Default: null

The model from which this model is derived, e.g. by fine-tuning the weights.

root oneOf item 2 oneOf bioimage.io model specification parent anyOf bioimageio__spec__model__v0_5__LinkedModel
Type: object

Reference to a bioimage.io model.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent anyOf LinkedModel id

Id

Type: string

A valid model id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification parent anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification run_mode
Default: null

Custom run mode for this model: for more complex prediction procedures like test time
data augmentation that currently cannot be expressed in the specification.
No standard run modes are defined yet.

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode kwargs

Kwargs

Type: object

Run mode specific key word arguments
root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification timestamp
Type: string Default: "2024-11-12T08:39:49.618269"

Timestamp in ISO 8601 format
with a few restrictions listed here.
(In Python a datetime object is valid, too).

root oneOf item 2 oneOf bioimage.io model specification training_data

Training Data

Default: null

The dataset used to train this model

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__LinkedDataset
Type: object

Reference to a bioimage.io dataset.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf LinkedDataset id

Id

Type: string

A valid dataset id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__DatasetDescr
Type: object

A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage
processing.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification name

Name

Type: string

A human-friendly name of the resource description.
May only contains letters, digits, underscore, minus, parentheses and spaces.

Must be at least 1 characters long

Must be at most 128 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification description

Description

Type: string

A string containing a brief description.

Must be at most 1024 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers

Covers

Type: array

Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.
The supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers covers items

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors

Authors

Type: array

The authors are the creators of this resource description and the primary points of contact.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification attachments

Attachments

Type: array

file attachments

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification attachments FileDescr
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite

Cite

Type: array

citations

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite CiteEntry
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite CiteEntry text

Text

Type: string

free text description

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification license

License

Type: string

A SPDX license identifier.
We do not support custom license beyond the SPDX license list, if you need that please
open a GitHub issue
to discuss your intentions with the community.


Examples:

CC0-1.0
@@ -532,4 +532,4 @@

root oneOf item 3 oneOf bioimage.io notebook specification badges

Badges

Type: array

badges associated with this resource

 No Additional Items

Each item of this array must be:

root oneOf item 3 oneOf bioimage.io notebook specification badges BadgeDescr
Type: object

A custom badge

 No Additional Properties

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge label

Label

Type: string

badge label to display on hover
Example:

Open in Colab

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge icon

Icon

Default: null

badge icon
Example:

https://colab.research.google.com/assets/colab-badge.svg

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge url

Url

Type: string

target URL
Example:

https://colab.research.google.com/github/HenriquesLab/ZeroCostDL4Mic/blob/master/Colab_notebooks/U-net_2D_ZeroCostDL4Mic.ipynb
-

root oneOf item 3 oneOf bioimage.io notebook specification type

Type

Type: const Default: "notebook"

Must be one of:

  • "notebook"
Specific value: "notebook"

root oneOf item 3 oneOf bioimage.io notebook specification id

Id

Default: null

Model zoo (bioimage.io) wide, unique identifier (assigned by bioimage.io)

root oneOf item 3 oneOf bioimage.io notebook specification source

Source


The Jupyter notebook

root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 0
Type: string
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 1
Type: stringFormat: file-path
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf RelativeFilePath
Type: string

A path relative to the rdf.yaml file (also if the RDF source is a URL).
\ No newline at end of file +

root oneOf item 3 oneOf bioimage.io notebook specification type

Type

Type: const Default: "notebook"

Must be one of:

  • "notebook"
Specific value: "notebook"

root oneOf item 3 oneOf bioimage.io notebook specification id

Id

Default: null

Model zoo (bioimage.io) wide, unique identifier (assigned by bioimage.io)

root oneOf item 3 oneOf bioimage.io notebook specification source

Source


The Jupyter notebook

root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 0
Type: string
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 1
Type: stringFormat: file-path
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf RelativeFilePath
Type: string

A path relative to the rdf.yaml file (also if the RDF source is a URL).
\ No newline at end of file diff --git a/bioimageio_schema_v0-5.json b/bioimageio_schema_v0-5.json index 5f560a3cc..62f3f16fd 100644 --- a/bioimageio_schema_v0-5.json +++ b/bioimageio_schema_v0-5.json @@ -6067,7 +6067,7 @@ }, "timestamp": { "$ref": "#/$defs/Datetime", - "default": "2024-11-11T21:46:37.480437", + "default": "2024-11-12T08:39:49.618269", "description": "Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).\n(In Python a datetime object is valid, too)." }, "training_data": { diff --git a/bioimageio_schema_v0-5/index.html b/bioimageio_schema_v0-5/index.html index 3f2d59a99..457cb17b2 100644 --- a/bioimageio_schema_v0-5/index.html +++ b/bioimageio_schema_v0-5/index.html @@ -378,7 +378,7 @@

root oneOf item 2 oneOf bioimage.io model specification outputs OutputTensorDescr postprocessing postprocessing items oneOf ScaleMeanVarianceDescr kwargs eps

Eps

Type: number Default: 1e-06

Epsilon for numeric stability:
out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.

Value must be strictly greater than 0.0 and lesser or equal to 0.1

root oneOf item 2 oneOf bioimage.io model specification packaged_by

Packaged By

Type: array

The persons that have packaged and uploaded this model.
Only required if those persons differ from the authors.

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification packaged_by Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification packaged_by Author orcid

Orcid

Default: null

An ORCID iD in hyphenated groups of 4 digits, (and valid as per ISO 7064 11,2.)
Example:

0000-0001-2345-6789
-

root oneOf item 2 oneOf bioimage.io model specification parent
Default: null

The model from which this model is derived, e.g. by fine-tuning the weights.

root oneOf item 2 oneOf bioimage.io model specification parent anyOf bioimageio__spec__model__v0_5__LinkedModel
Type: object

Reference to a bioimage.io model.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent anyOf LinkedModel id

Id

Type: string

A valid model id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification parent anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification run_mode
Default: null

Custom run mode for this model: for more complex prediction procedures like test time
data augmentation that currently cannot be expressed in the specification.
No standard run modes are defined yet.

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode kwargs

Kwargs

Type: object

Run mode specific key word arguments
root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification timestamp
Type: string Default: "2024-11-11T21:46:37.480437"

Timestamp in ISO 8601 format
with a few restrictions listed here.
(In Python a datetime object is valid, too).

root oneOf item 2 oneOf bioimage.io model specification training_data

Training Data

Default: null

The dataset used to train this model

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__LinkedDataset
Type: object

Reference to a bioimage.io dataset.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf LinkedDataset id

Id

Type: string

A valid dataset id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__DatasetDescr
Type: object

A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage
processing.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification name

Name

Type: string

A human-friendly name of the resource description.
May only contains letters, digits, underscore, minus, parentheses and spaces.

Must be at least 1 characters long

Must be at most 128 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification description

Description

Type: string

A string containing a brief description.

Must be at most 1024 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers

Covers

Type: array

Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.
The supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers covers items

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors

Authors

Type: array

The authors are the creators of this resource description and the primary points of contact.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent
Default: null

The model from which this model is derived, e.g. by fine-tuning the weights.

root oneOf item 2 oneOf bioimage.io model specification parent anyOf bioimageio__spec__model__v0_5__LinkedModel
Type: object

Reference to a bioimage.io model.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification parent anyOf LinkedModel id

Id

Type: string

A valid model id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification parent anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification run_mode
Default: null

Custom run mode for this model: for more complex prediction procedures like test time
data augmentation that currently cannot be expressed in the specification.
No standard run modes are defined yet.

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf RunMode kwargs

Kwargs

Type: object

Run mode specific key word arguments
root oneOf item 2 oneOf bioimage.io model specification run_mode anyOf item 1
Type: null

root oneOf item 2 oneOf bioimage.io model specification timestamp
Type: string Default: "2024-11-12T08:39:49.618269"

Timestamp in ISO 8601 format
with a few restrictions listed here.
(In Python a datetime object is valid, too).

root oneOf item 2 oneOf bioimage.io model specification training_data

Training Data

Default: null

The dataset used to train this model

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__LinkedDataset
Type: object

Reference to a bioimage.io dataset.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf LinkedDataset id

Id

Type: string

A valid dataset id from the bioimage.io collection.
root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimageio__spec__dataset__v0_3__DatasetDescr
Type: object

A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage
processing.

 No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification name

Name

Type: string

A human-friendly name of the resource description.
May only contains letters, digits, underscore, minus, parentheses and spaces.

Must be at least 1 characters long

Must be at most 128 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification description

Description

Type: string

A string containing a brief description.

Must be at most 1024 characters long

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers

Covers

Type: array

Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.
The supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification covers covers items

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors

Authors

Type: array

The authors are the creators of this resource description and the primary points of contact.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification authors Author
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification attachments

Attachments

Type: array

file attachments

 No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification attachments FileDescr
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite

Cite

Type: array

citations

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite CiteEntry
Type: object
No Additional Properties

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification cite CiteEntry text

Text

Type: string

free text description

root oneOf item 2 oneOf bioimage.io model specification training_data anyOf bioimage.io dataset specification license

License

Type: string

A SPDX license identifier.
We do not support custom license beyond the SPDX license list, if you need that please
open a GitHub issue
to discuss your intentions with the community.


Examples:

CC0-1.0
@@ -532,4 +532,4 @@

root oneOf item 3 oneOf bioimage.io notebook specification badges

Badges

Type: array

badges associated with this resource

 No Additional Items

Each item of this array must be:

root oneOf item 3 oneOf bioimage.io notebook specification badges BadgeDescr
Type: object

A custom badge

 No Additional Properties

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge label

Label

Type: string

badge label to display on hover
Example:

Open in Colab

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge icon

Icon

Default: null

badge icon
Example:

https://colab.research.google.com/assets/colab-badge.svg

root oneOf item 3 oneOf bioimage.io notebook specification badges Custom badge url

Url

Type: string

target URL
Example:

https://colab.research.google.com/github/HenriquesLab/ZeroCostDL4Mic/blob/master/Colab_notebooks/U-net_2D_ZeroCostDL4Mic.ipynb
-

root oneOf item 3 oneOf bioimage.io notebook specification type

Type

Type: const Default: "notebook"

Must be one of:

  • "notebook"
Specific value: "notebook"

root oneOf item 3 oneOf bioimage.io notebook specification id

Id

Default: null

Model zoo (bioimage.io) wide, unique identifier (assigned by bioimage.io)

root oneOf item 3 oneOf bioimage.io notebook specification source

Source


The Jupyter notebook

root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 0
Type: string
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 1
Type: stringFormat: file-path
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf RelativeFilePath
Type: string

A path relative to the rdf.yaml file (also if the RDF source is a URL).
\ No newline at end of file +

root oneOf item 3 oneOf bioimage.io notebook specification type

Type

Type: const Default: "notebook"

Must be one of:

  • "notebook"
Specific value: "notebook"

root oneOf item 3 oneOf bioimage.io notebook specification id

Id

Default: null

Model zoo (bioimage.io) wide, unique identifier (assigned by bioimage.io)

root oneOf item 3 oneOf bioimage.io notebook specification source

Source


The Jupyter notebook

root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 0
Type: string
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf item 1
Type: stringFormat: file-path
root oneOf item 3 oneOf bioimage.io notebook specification source anyOf RelativeFilePath
Type: string

A path relative to the rdf.yaml file (also if the RDF source is a URL).
\ No newline at end of file diff --git a/coverage/class_index.html b/coverage/class_index.html index 81f03f3ee..b19da15e6 100644 --- a/coverage/class_index.html +++ b/coverage/class_index.html @@ -55,7 +55,7 @@

coverage.py v7.6.4, - created at 2024-11-11 21:45 +0000 + created at 2024-11-12 08:38 +0000

@@ -2180,7 +2180,7 @@

coverage.py v7.6.4, - created at 2024-11-11 21:45 +0000 + created at 2024-11-12 08:38 +0000