dataeval.typing

Common type hints used for interoperability with DataEval.

Attributes

ArrayLike

Type alias for array-like objects used for interoperability with DataEval.

ImageClassificationDataset

A type definition for an AnnotatedDataset of ImageClassificationDatum elements.

ImageClassificationDatum

A type definition for an image classification datum tuple.

ObjectDetectionDataset

A type definition for an AnnotatedDataset of ObjectDetectionDatum elements.

ObjectDetectionDatum

A type definition for an object detection datum tuple.

SegmentationDataset

A type definition for an AnnotatedDataset of SegmentationDatum elements.

SegmentationDatum

A type definition for an image classification datum tuple.

Classes

AnnotatedDataset

Protocol for a generic AnnotatedDataset.

Array

Protocol for array objects providing interoperability with DataEval.

Dataset

Protocol for a generic Dataset.

DatasetMetadata

Dataset level metadata required for all AnnotatedDataset classes.

ObjectDetectionTarget

A protocol for targets in an Object Detection dataset.

SegmentationTarget

A protocol for targets in a Segmentation dataset.

Module Contents

dataeval.typing.ArrayLike : TypeAlias = Union[Sequence[_ScalarType], Sequence[Sequence[_ScalarType]], Sequence[Array], Array]

Type alias for array-like objects used for interoperability with DataEval.

This includes native Python sequences, as well as objects that conform to the Array protocol.

dataeval.typing.ImageClassificationDataset : TypeAlias = AnnotatedDataset[ImageClassificationDatum]

A type definition for an AnnotatedDataset of ImageClassificationDatum elements.

dataeval.typing.ImageClassificationDatum : TypeAlias = tuple[Array, Array, dict[str, Any]]

A type definition for an image classification datum tuple.

  • Array of shape (C, H, W) - Image data in channel, height, width format.

  • Array of shape (N,) - Class label as one-hot encoded ground-truth or prediction confidences.

  • dict[str, Any] - Datum level metadata.

dataeval.typing.ObjectDetectionDataset : TypeAlias = AnnotatedDataset[ObjectDetectionDatum]

A type definition for an AnnotatedDataset of ObjectDetectionDatum elements.

dataeval.typing.ObjectDetectionDatum : TypeAlias = tuple[Array, ObjectDetectionTarget, dict[str, Any]]

A type definition for an object detection datum tuple.

  • Array of shape (C, H, W) - Image data in channel, height, width format.

  • ObjectDetectionTarget - Object detection target information for the image.

  • dict[str, Any] - Datum level metadata.

dataeval.typing.SegmentationDataset : TypeAlias = AnnotatedDataset[SegmentationDatum]

A type definition for an AnnotatedDataset of SegmentationDatum elements.

dataeval.typing.SegmentationDatum : TypeAlias = tuple[Array, SegmentationTarget, dict[str, Any]]

A type definition for an image classification datum tuple.

  • Array of shape (C, H, W) - Image data in channel, height, width format.

  • SegmentationTarget - Segmentation target information for the image.

  • dict[str, Any] - Datum level metadata.