Skip to main content

Parser and validator library for bioimage.io specifications

Project description

License PyPI conda-version downloads conda-forge downloads Ruff coverage

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. 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 and may be produced or consumed by bioimage.io-compatible consumers (e.g., image analysis software like ilastik).

These 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. 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 Python package. The bioimageio.core Python package also provides the bioimageio command line interface (CLI) with the test command:

bioimageio test path/to/your/rdf.yaml

Documentation

The bioimageio.spec documentation is hosted at https://bioimage-io.github.io/spec-bioimage-io.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bioimageio_spec-0.5.7.3.tar.gz (220.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bioimageio_spec-0.5.7.3-py3-none-any.whl (242.6 kB view details)

Uploaded Python 3

File details

Details for the file bioimageio_spec-0.5.7.3.tar.gz.

File metadata

  • Download URL: bioimageio_spec-0.5.7.3.tar.gz
  • Upload date:
  • Size: 220.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bioimageio_spec-0.5.7.3.tar.gz
Algorithm Hash digest
SHA256 1bc51fe10e34d475267f228c837f13cd64b038cf232359605925b71caadb11ea
MD5 6b7f10f8da8ac6251cf05310ea1fb4d5
BLAKE2b-256 735867bb49fb76a02ab2f0977befed47c061158bfe63aa1d9b8423f96a27effa

See more details on using hashes here.

Provenance

The following attestation bundles were made for bioimageio_spec-0.5.7.3.tar.gz:

Publisher: build.yaml on bioimage-io/spec-bioimage-io

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bioimageio_spec-0.5.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for bioimageio_spec-0.5.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ef4dae67968a1e6ee601cd6f35eb9aaefc4116239c578a9db6d748d4fd2dcc12
MD5 bac317a85bd8f0081d470cb4da7e1ba4
BLAKE2b-256 667010a56dff6be6729b05d215182f0ac9a900d24b42766c680079cab8d3b7ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for bioimageio_spec-0.5.7.3-py3-none-any.whl:

Publisher: build.yaml on bioimage-io/spec-bioimage-io

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page