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

60 statements  

« prev     ^ index     » next       coverage.py v7.17.3, created at 2026-11-20 09:46 +0000

1"""bioimageio.core --- core functionality for BioImage.IO resources 

2 

3The main focus on this library is to provide functionality to run prediction with 

4BioImage.IO models, including standardized pre- and postprocessing operations. 

5The BioImage.IO models (and other resources) are described by---and can be loaded with---the bioimageio.spec package. 

6 

7See `predict` and `predict_many` for straight-forward model inference 

8and `create_prediction_pipeline` for finer control of the inference process. 

9 

10Other notable bioimageio.core functionalities include: 

11- Testing BioImage.IO resources beyond format validation, e.g. by generating model outputs from test inputs. 

12 See `test_model` or for arbitrary resource types `test_description`. 

13- Extending available model weight formats by converting existing ones, see `add_weights`. 

14- Creating and manipulating `Sample`s consisting of tensors with associated statistics. 

15- Computing statistics on datasets (represented as sequences of samples), see `compute_dataset_measures`. 

16""" 

17 

18__version__ = "0.12.0" 

19from loguru import logger 

20 

21logger.disable("bioimageio.core") 

22 

23 

24from bioimageio.spec import ValidationSummary as ValidationSummary 

25from bioimageio.spec import build_description as build_description 

26from bioimageio.spec import dump_description as dump_description 

27from bioimageio.spec import load_dataset_description as load_dataset_description 

28from bioimageio.spec import load_description as load_description 

29from bioimageio.spec import ( 

30 load_description_and_validate_format_only as load_description_and_validate_format_only, 

31) 

32from bioimageio.spec import load_model_description as load_model_description 

33from bioimageio.spec import save_bioimageio_package as save_bioimageio_package 

34from bioimageio.spec import ( 

35 save_bioimageio_package_as_folder as save_bioimageio_package_as_folder, 

36) 

37from bioimageio.spec import save_bioimageio_yaml_only as save_bioimageio_yaml_only 

38from bioimageio.spec import validate_format as validate_format 

39 

40from . import axis as axis 

41from . import backends as backends 

42from . import cli as cli 

43from . import commands as commands 

44from . import common as common 

45from . import digest_spec as digest_spec 

46from . import io as io 

47from . import prediction as prediction 

48from . import proc_ops as proc_ops 

49from . import proc_setup as proc_setup 

50from . import sample as sample 

51from . import stat_calculators as stat_calculators 

52from . import stat_measures as stat_measures 

53from . import tensor as tensor 

54from . import weight_converters as weight_converters 

55from ._prediction_pipeline import PredictionPipeline as PredictionPipeline 

56from ._prediction_pipeline import RemotePredictionPipeline as RemotePredictionPipeline 

57from ._prediction_pipeline import ( 

58 create_prediction_pipeline as create_prediction_pipeline, 

59) 

60from ._prediction_pipeline import ( 

61 create_remote_prediction_pipeline as create_remote_prediction_pipeline, 

62) 

63from ._resource_tests import enable_determinism as enable_determinism 

64from ._resource_tests import load_description_and_test as load_description_and_test 

65from ._resource_tests import test_description as test_description 

66from ._resource_tests import test_model as test_model 

67from ._sample_serializer import SampleSerializer as SampleSerializer 

68from ._settings import Settings as Settings 

69from ._settings import settings as settings 

70 

71# reexports from bioimageio.core submodules 

72from .axis import Axis as Axis 

73from .axis import AxisId as AxisId 

74from .backends import create_model_adapter as create_model_adapter 

75from .block import apply_blockwise as apply_blockwise 

76from .common import MemberId as MemberId 

77from .prediction import predict as predict 

78from .prediction import predict_many as predict_many 

79from .sample import Sample as Sample 

80from .stat_calculators import compute_dataset_measures as compute_dataset_measures 

81from .stat_calculators import compute_measures as compute_measures 

82from .stat_calculators import compute_sample_measures as compute_sample_measures 

83from .stat_measures import Stat as Stat 

84from .tensor import Tensor as Tensor 

85from .weight_converters import add_weights as add_weights 

86 

87# aliases 

88test_resource = test_description 

89"""alias of `test_description`""" 

90load_resource = load_description 

91"""alias of `load_description`""" 

92load_model = load_model_description 

93"""alias of `load_model_description`"""