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.4.tar.gz (221.4 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.4-py3-none-any.whl (243.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bioimageio_spec-0.5.7.4.tar.gz
  • Upload date:
  • Size: 221.4 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.4.tar.gz
Algorithm Hash digest
SHA256 73411ede01c454e6a6ed7ed5d6ddbeffa0944051d314487382c1d5c256f0161a
MD5 524928d7eeada0134d99d4071bcb0ca2
BLAKE2b-256 5c6cdb118e6fde645ab80e1d2d5b27b9b186b0abaa482aad7d6eb86ef766f724

See more details on using hashes here.

Provenance

The following attestation bundles were made for bioimageio_spec-0.5.7.4.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.4-py3-none-any.whl.

File metadata

File hashes

Hashes for bioimageio_spec-0.5.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7a07e3ac7b31bf022856a4ab710ccdd917e27111778c786e1c1fa80be4885b1f
MD5 7794251706762cf46aa49a182e6b9cec
BLAKE2b-256 da6c086aa25b0fd6c0d2f0c849390607891d7e50aa0d45dc1ce2d9541e6e756e

See more details on using hashes here.

Provenance

The following attestation bundles were made for bioimageio_spec-0.5.7.4-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