Skip to content

Attributes

AttributeSummary module-attribute 

AttributeSummary = Annotated[IntegerAttribute | FloatAttribute | BooleanAttribute | DateAttribute | NominalAttribute, Field(discriminator='type')]

Union type for all supported attribute summary structures.

This type is used as the return value for attribute summarization, where each attribute is represented by one of the specialized summary dataclasses depending on its inferred type.

The type field is used as a discriminator, enabling Pydantic to correctly parse the variant.

Possible variants
  • IntegerAttribute
  • FloatAttribute
  • BooleanAttribute
  • DateAttribute
  • NominalAttribute
Returned by:

IntegerAttribute dataclass

Summary information for an integer attribute.

Attributes:

Name Type Description
attribute str

Name of the attribute.
type Literal['integer']

The attribute’s inferred data type ("integer").
min int

The minimum observed value.
max int

The maximum observed value.
Source code in src/ocelescope/src/ocelescope/ocel/models/attributes.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@dataclass
class IntegerAttribute:
    """
    Summary information for an integer attribute.

    Attributes:
        attribute (str):
            Name of the attribute.
        type (Literal["integer"]):
            The attribute’s inferred data type ("integer").
        min (int):
            The minimum observed value.
        max (int):
            The maximum observed value.
    """

    attribute: str
    type: Literal["integer"]
    min: int
    max: int

FloatAttribute dataclass

Summary information for a floating-point numerical attribute.

Attributes:

Name Type Description
attribute str

Name of the attribute.
type Literal['float']

The attribute’s inferred data type ("float").
min float

The minimum observed value.
max float

The maximum observed value.
Source code in src/ocelescope/src/ocelescope/ocel/models/attributes.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@dataclass
class FloatAttribute:
    """
    Summary information for a floating-point numerical attribute.

    Attributes:
        attribute (str):
            Name of the attribute.
        type (Literal["float"]):
            The attribute’s inferred data type ("float").
        min (float):
            The minimum observed value.
        max (float):
            The maximum observed value.
    """

    attribute: str
    type: Literal["float"]
    min: float
    max: float

BooleanAttribute dataclass

Summary information for a boolean attribute.

Attributes:

Name Type Description
attribute str

Name of the attribute.
type Literal['boolean']

The attribute’s inferred data type ("boolean").
true_count int

Number of events or objects where the value was True.
false_count int

Number of events or objects where the value was False.
Source code in src/ocelescope/src/ocelescope/ocel/models/attributes.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@dataclass
class BooleanAttribute:
    """
    Summary information for a boolean attribute.

    Attributes:
        attribute (str):
            Name of the attribute.
        type (Literal["boolean"]):
            The attribute’s inferred data type ("boolean").
        true_count (int):
            Number of events or objects where the value was True.
        false_count (int):
            Number of events or objects where the value was False.
    """

    attribute: str
    type: Literal["boolean"]
    true_count: int
    false_count: int

DateAttribute dataclass

Summary information for a date or timestamp attribute.

Attributes:

Name Type Description
attribute str

Name of the attribute.
type Literal['date']

The attribute’s inferred data type ("date").
min str

The earliest observed value (ISO timestamp string).
max str

The latest observed value (ISO timestamp string).
Source code in src/ocelescope/src/ocelescope/ocel/models/attributes.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
@dataclass
class DateAttribute:
    """
    Summary information for a date or timestamp attribute.

    Attributes:
        attribute (str):
            Name of the attribute.
        type (Literal["date"]):
            The attribute’s inferred data type ("date").
        min (str):
            The earliest observed value (ISO timestamp string).
        max (str):
            The latest observed value (ISO timestamp string).
    """

    attribute: str
    type: Literal["date"]
    min: str
    max: str

NominalAttribute dataclass

Summary information for a categorical (nominal) attribute.

Attributes:

Name Type Description
attribute str

Name of the attribute.
type Literal['nominal']

The attribute’s inferred data type ("nominal").
num_unique int

Number of distinct categories observed.
Source code in src/ocelescope/src/ocelescope/ocel/models/attributes.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@dataclass
class NominalAttribute:
    """
    Summary information for a categorical (nominal) attribute.

    Attributes:
        attribute (str):
            Name of the attribute.
        type (Literal["nominal"]):
            The attribute’s inferred data type ("nominal").
        num_unique (int):
            Number of distinct categories observed.
    """

    attribute: str
    type: Literal["nominal"]
    num_unique: int