Skip to content

archaeo_super_prompt.types.results

[docs] module archaeo_super_prompt.types.results 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
"""Uniform data results."""

import pandera.pandas as pa
from pandera.typing.pandas import Series


class ResultSchema(pa.DataFrameModel):
    """DataFrame with the result for one record and one field."""
    id: Series[int] = pa.Field()
    field_name: Series[str] = pa.Field()  # TODO: convert it into categories
    predicted_value: Series[pa.Object] = pa.Field(nullable=True)
    expected_value: Series[pa.Object] = pa.Field(nullable=True)
    evaluation_method: Series[str] = (
        pa.Field()
    )  # TODO: convert it into categories
    metric_value: Series[float] = pa.Field()