Skip to content

Prediction

Bases: StaticCollection

An object describing a prediction (e.g., a machine-drawn bounding box on an image).

Attributes:

Name Type Description
datum Datum

The datum associated with the prediction.
annotations List[Annotation]

The list of annotations associated with the prediction.

Examples:

>>> Prediction(
...     datum=Datum(uid="uid1"),
...     annotations=[
...         Annotation(
...             labels=[
...                 Label(key="k1", value="v1", score=0.9),
...                 Label(key="k1", value="v1", score=0.1)
...             ],
...         )
...     ]
... )
Source code in valor/coretypes.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class Prediction(StaticCollection):
    """
    An object describing a prediction (e.g., a machine-drawn bounding box on an image).

    Attributes
    ----------
    datum : Datum
        The datum associated with the prediction.
    annotations : List[Annotation]
        The list of annotations associated with the prediction.

    Examples
    --------
    >>> Prediction(
    ...     datum=Datum(uid="uid1"),
    ...     annotations=[
    ...         Annotation(
    ...             labels=[
    ...                 Label(key="k1", value="v1", score=0.9),
    ...                 Label(key="k1", value="v1", score=0.1)
    ...             ],
    ...         )
    ...     ]
    ... )
    """

    datum: Datum = Datum.symbolic(owner="prediction", name="datum")
    annotations: SymbolicList[Annotation] = SymbolicList[Annotation].symbolic(
        owner="prediction", name="annotations"
    )

    def __init__(
        self,
        *,
        datum: Datum,
        annotations: List[Annotation],
    ):
        """
        Creates a prediction.

        Parameters
        ----------
        datum : Datum
            The datum that the prediction is operating over.
        annotations : List[Annotation]
            The list of predicted annotations.
        """
        super().__init__(datum=datum, annotations=annotations)

Functions

valor.Prediction.__init__(*, datum, annotations)

Creates a prediction.

Parameters:

Name Type Description Default
datum Datum

The datum that the prediction is operating over.

 required
annotations List[Annotation]

The list of predicted annotations.

 required
Source code in valor/coretypes.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def __init__(
    self,
    *,
    datum: Datum,
    annotations: List[Annotation],
):
    """
    Creates a prediction.

    Parameters
    ----------
    datum : Datum
        The datum that the prediction is operating over.
    annotations : List[Annotation]
        The list of predicted annotations.
    """
    super().__init__(datum=datum, annotations=annotations)