Metadata-Version: 2.4
Name: bioimageio.spec
Version: 0.5.8.0
Summary: Parser and validator library for bioimage.io specifications
Author-email: Fynn Beuttenmüller <thefynnbe@gmail.com>
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: annotated-types<1,>=0.5.0
Requires-Dist: email-validator
Requires-Dist: exceptiongroup
Requires-Dist: genericache==0.5.2
Requires-Dist: httpx
Requires-Dist: imageio
Requires-Dist: loguru
Requires-Dist: markdown
Requires-Dist: numpy>=1.21
Requires-Dist: packaging>=17.0
Requires-Dist: platformdirs
Requires-Dist: pydantic-core
Requires-Dist: pydantic-settings<3,>=2.5
Requires-Dist: pydantic<3,>=2.10.3
Requires-Dist: python-dateutil
Requires-Dist: rich
Requires-Dist: ruyaml
Requires-Dist: tifffile>=2020.7.4
Requires-Dist: tqdm
Requires-Dist: typing-extensions
Requires-Dist: zipp
Provides-Extra: dev
Requires-Dist: deepdiff; extra == "dev"
Requires-Dist: devtools; extra == "dev"
Requires-Dist: griffe-inherited-docstrings; extra == "dev"
Requires-Dist: griffe-public-redundant-aliases; extra == "dev"
Requires-Dist: griffe-pydantic; extra == "dev"
Requires-Dist: huggingface-hub; extra == "dev"
Requires-Dist: json-schema-for-humans; extra == "dev"
Requires-Dist: jsonschema; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: lxml; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: nbval; extra == "dev"
Requires-Dist: pdoc; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pyright==1.1.408; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: python-dotenv; extra == "dev"
Requires-Dist: respx; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: torch; extra == "dev"
Provides-Extra: docs
Requires-Dist: markdown-callouts; extra == "docs"
Requires-Dist: markdown-exec[ansi]; extra == "docs"
Requires-Dist: markdown-pycon; extra == "docs"
Requires-Dist: mike; extra == "docs"
Requires-Dist: mkdocs-api-autonav; extra == "docs"
Requires-Dist: mkdocs-coverage; extra == "docs"
Requires-Dist: mkdocs-gen-files; extra == "docs"
Requires-Dist: mkdocs-literate-nav; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-section-index; extra == "docs"
Dynamic: license-file

![License](https://img.shields.io/github/license/bioimage-io/spec-bioimage-io.svg)
[![PyPI](https://img.shields.io/pypi/v/bioimageio-spec.svg?style=popout)](https://pypi.org/project/bioimageio.spec/)
[![conda-version](https://anaconda.org/conda-forge/bioimageio.spec/badges/version.svg)](https://anaconda.org/conda-forge/bioimageio.spec/)
[![downloads](https://static.pepy.tech/badge/bioimageio.spec)](https://pepy.tech/project/bioimageio.spec)
[![conda-forge downloads](https://img.shields.io/conda/dn/conda-forge/bioimageio.spec.svg?label=conda-forge)](https://anaconda.org/conda-forge/bioimageio.spec/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![coverage](https://bioimage-io.github.io/spec-bioimage-io/coverage/coverage-badge.svg)](https://bioimage-io.github.io/spec-bioimage-io/coverage/index.html)

# Specifications for bioimage.io

This repository contains the specifications of the standard format defined by the bioimage.io community for the content (i.e., models, datasets and applications) in the [bioimage.io website](https://bioimage.io).
Each item in the content is always described using a YAML 1.2 file named `rdf.yaml` or `bioimageio.yaml`.
This `rdf.yaml` \ `bioimageio.yaml`--- along with the files referenced in it --- can be downloaded from or uploaded to the [bioimage.io website](https://bioimage.io) and may be produced or consumed by bioimage.io-compatible consumers (e.g., image analysis software like ilastik).

[These](https://bioimage-io.github.io/spec-bioimage-io/#format-version-overview) are the latest format specifications that bioimage.io-compatible resources should comply to.

Note that the Python package PyYAML does not support YAML 1.2 .
We therefore use and recommend [ruyaml](https://ruyaml.readthedocs.io/en/latest/).
For differences see <https://ruamelyaml.readthedocs.io/en/latest/pyyaml>.

Please also note that the best way to check whether your `rdf.yaml` file is fully bioimage.io-compliant, is to call `bioimageio.core.test_description` from the [bioimageio.core](https://github.com/bioimage-io/core-bioimage-io-python) Python package.
The [bioimageio.core](https://github.com/bioimage-io/core-bioimage-io-python) Python package also provides the bioimageio command line interface (CLI) with the `test` command:

```terminal
bioimageio test path/to/your/rdf.yaml
```

## Documentation

The bioimageio.spec documentation is hosted at [https://bioimage-io.github.io/spec-bioimage-io](https://bioimage-io.github.io/spec-bioimage-io).
