MODULE REFERENCE

observations

anomx.data.views.observations

Canonical observation container shared by every anomx pipeline.

An ObservationSet is a collection of observations plus optional structural information. Independent samples, sequences, time series, panel data, and graph-backed observations are all expressed through the same container; algorithms consume standardized views instead of raw storage formats.

ObservationSet

ObservationSet(observations: pd.DataFrame, feature_columns: list[str] = <factory: list>, target_columns: list[str] = <factory: list>, entity_column: str | None = None, sequence_column: str | None = None, timestamp_column: str | None = None, position_column: str | None = None, relations: RelationSet | None = None, hierarchy: Hierarchy | None = None, metadata: dict[str, Any] = <factory: dict>)

A table of observations together with optional structural overlays.

Signature parameters
ParameterTypeDefault
observationspd.DataFramerequired
feature_columnslist[str]<factory: list>
target_columnslist[str]<factory: list>
entity_columnstr | NoneNone
sequence_columnstr | NoneNone
timestamp_columnstr | NoneNone
position_columnstr | NoneNone
relationsRelationSet | NoneNone
hierarchyHierarchy | NoneNone
metadatadict[str, Any]<factory: dict>

Members

observationsattribute
observations: pd.DataFrame
feature_columnsattribute
feature_columns: list[str] = field(default_factory=list)
target_columnsattribute
target_columns: list[str] = field(default_factory=list)
entity_columnattribute
entity_column: str | None = None
sequence_columnattribute
sequence_column: str | None = None
timestamp_columnattribute
timestamp_column: str | None = None
position_columnattribute
position_column: str | None = None
relationsattribute
relations: RelationSet | None = None
hierarchyattribute
hierarchy: Hierarchy | None = None
metadataattribute
metadata: dict[str, Any] = field(default_factory=dict)
observation_countproperty
observation_count: int

Returns int

characteristicsmethod
characteristics() -> DataCharacteristics

Derive the orthogonal structural properties of this set.

Returns DataCharacteristics

as_tabularmethod
as_tabular() -> TabularView

Materialize an unordered n_samples × n_features matrix.

Returns TabularView

as_sequencesmethod
as_sequences(*, group_by: str | None = None) -> SequenceView

Materialize per-sequence ordered frames.

Signature parameters
ParameterTypeDefault
group_bykeyword onlystr | NoneNone

Returns SequenceView

as_windowsmethod
as_windows(*, window_size: int, stride: int = 1, group_by: str | None = None) -> WindowView

Materialize fixed-size sliding windows over ordered observations.

Signature parameters
ParameterTypeDefault
window_sizekeyword onlyintrequired
stridekeyword onlyint1
group_bykeyword onlystr | NoneNone

Returns WindowView

as_timeseriesmethod
as_timeseries() -> TimeSeriesView

Materialize a time-indexed frame for temporal models.

Returns TimeSeriesView

as_graphmethod
as_graph() -> GraphView

Materialize node features with the relational overlay.

Returns GraphView

REGULAR_SAMPLING_RELATIVE_TOLERANCE

REGULAR_SAMPLING_RELATIVE_TOLERANCE = 0.01