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 ( 

19 application, 

20 common, 

21 conda_env, 

22 dataset, 

23 generic, 

24 model, 

25 summary, 

26 utils, 

27) 

28from ._description import ( 

29 LatestResourceDescr, 

30 ResourceDescr, 

31 SpecificResourceDescr, 

32 build_description, 

33 dump_description, 

34 validate_format, 

35) 

36from ._get_conda_env import get_conda_env 

37from ._internal import settings 

38from ._internal.common_nodes import InvalidDescr 

39from ._internal.validation_context import ValidationContext, get_validation_context 

40from ._io import ( 

41 load_dataset_description, 

42 load_description, 

43 load_description_and_validate_format_only, 

44 load_model_description, 

45 save_bioimageio_yaml_only, 

46 update_format, 

47 update_hashes, 

48) 

49from ._package import ( 

50 get_resource_package_content, 

51 save_bioimageio_package, 

52 save_bioimageio_package_as_folder, 

53 save_bioimageio_package_to_stream, 

54) 

55from ._pretty_validation_errors import PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED 

56from ._upload import upload 

57from ._version import VERSION as __version__ 

58from .application import AnyApplicationDescr, ApplicationDescr 

59from .dataset import AnyDatasetDescr, DatasetDescr 

60from .generic import AnyGenericDescr, GenericDescr 

61from .model import AnyModelDescr, ModelDescr 

62from .notebook import AnyNotebookDescr, NotebookDescr 

63 

64BioimageioCondaEnv = conda_env.BioimageioCondaEnv 

65ValidationSummary = summary.ValidationSummary 

66 

67__all__ = [ 

68 "__version__", 

69 "AnyApplicationDescr", 

70 "AnyDatasetDescr", 

71 "AnyGenericDescr", 

72 "AnyModelDescr", 

73 "AnyNotebookDescr", 

74 "application", 

75 "ApplicationDescr", 

76 "PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED", 

77 "BioimageioCondaEnv", 

78 "build_description", 

79 "common", 

80 "conda_env", 

81 "dataset", 

82 "DatasetDescr", 

83 "dump_description", 

84 "generic", 

85 "GenericDescr", 

86 "get_conda_env", 

87 "get_resource_package_content", 

88 "get_validation_context", 

89 "InvalidDescr", 

90 "LatestResourceDescr", 

91 "load_dataset_description", 

92 "load_description_and_validate_format_only", 

93 "load_description", 

94 "load_model_description", 

95 "model", 

96 "ModelDescr", 

97 "NotebookDescr", 

98 "ResourceDescr", 

99 "save_bioimageio_package_as_folder", 

100 "save_bioimageio_package_to_stream", 

101 "save_bioimageio_package", 

102 "save_bioimageio_yaml_only", 

103 "settings", 

104 "SpecificResourceDescr", 

105 "summary", 

106 "update_format", 

107 "update_hashes", 

108 "upload", 

109 "utils", 

110 "validate_format", 

111 "ValidationContext", 

112 "ValidationSummary", 

113]