Coverage for src / bioimageio / spec / __init__.py: 100%

1"""bioimageio.spec --- BioImage.IO specifications in Python. 

2 

3This package provides Pydantic data models for BioImage.IO resource descriptions and tools to work with such descriptions. 

4 

5The BioImage.IO resource description format is resource type specific (e.g. models, datasets) and versioned. 

6bioimageio.spec defines and validates these specifications and is backwards compatible with previous format versions. 

7It also provides download/upload to/from the BioImage.IO Model Zoo at https://bioimage.io. 

8 

9Note: 

10 For additional tools to work with BioImage.IO resources in Python, consider using the [bioimageio.core](https://bioimage-io.github.io/core-bioimage-io-python) package. 

11""" 

12 

13# ruff: noqa: E402 

14from loguru import logger 

15 

16logger.disable("bioimageio.spec") 

17 

18from . import _version 

19from . import application as application 

20from . import common as common 

21from . import conda_env as conda_env 

22from . import dataset as dataset 

23from . import generic as generic 

24from . import model as model 

25from . import notebook as notebook 

26from . import summary as summary 

27from . import utils as utils 

28from ._description import LatestResourceDescr as LatestResourceDescr 

29from ._description import ResourceDescr as ResourceDescr 

30from ._description import SpecificResourceDescr as SpecificResourceDescr 

31from ._description import build_description as build_description 

32from ._description import dump_description as dump_description 

33from ._description import validate_format as validate_format 

34from ._get_conda_env import get_conda_env as get_conda_env 

35from ._internal import common_nodes, validation_context 

36from ._internal import settings as settings 

37from ._io import load_dataset_description as load_dataset_description 

38from ._io import load_description as load_description 

39from ._io import ( 

40 load_description_and_validate_format_only as load_description_and_validate_format_only, 

41) 

42from ._io import load_model_description as load_model_description 

43from ._io import save_bioimageio_yaml_only as save_bioimageio_yaml_only 

44from ._io import update_format as update_format 

45from ._io import update_hashes as update_hashes 

46from ._package import get_resource_package_content as get_resource_package_content 

47from ._package import save_bioimageio_package as save_bioimageio_package 

48from ._package import ( 

49 save_bioimageio_package_as_folder as save_bioimageio_package_as_folder, 

50) 

51from ._package import ( 

52 save_bioimageio_package_to_stream as save_bioimageio_package_to_stream, 

53) 

54from ._pretty_validation_errors import ( 

55 PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED as PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED, 

56) 

57from ._upload import upload as upload 

58 

59__version__ = _version.VERSION 

60 

61# reexpose slected objects from submodules 

62AnyApplicationDescr = application.AnyApplicationDescr 

63AnyDatasetDescr = dataset.AnyDatasetDescr 

64AnyGenericDescr = generic.AnyGenericDescr 

65AnyModelDescr = model.AnyModelDescr 

66AnyNotebookDescr = notebook.AnyNotebookDescr 

67ApplicationDescr = application.ApplicationDescr 

68BioimageioCondaEnv = conda_env.BioimageioCondaEnv 

69DatasetDescr = dataset.DatasetDescr 

70GenericDescr = generic.GenericDescr 

71get_validation_context = validation_context.get_validation_context 

72InvalidDescr = common_nodes.InvalidDescr 

73ModelDescr = model.ModelDescr 

74NotebookDescr = notebook.NotebookDescr 

75ValidationContext = validation_context.ValidationContext 

76ValidationSummary = summary.ValidationSummary