MODULE REFERENCE

characteristics

anomx.data.base.characteristics

Orthogonal descriptive properties of an observation set.

Instead of hard-coding mutually exclusive dataset types (samples, sequences, time series, graphs, hierarchies), an ObservationSet is described by independent structural dimensions. Algorithms declare requirements against these dimensions through anomx.base.ComponentCapabilities.

classView source ↗

DataCharacteristics

DataCharacteristics(ordering: Ordering = Ordering.UNORDERED, temporal_semantics: TemporalSemantics = TemporalSemantics.NONE, grouping: Grouping = Grouping.SINGLE_POPULATION, topology: Topology = Topology.NONE, structure: Structure = Structure.FLAT, modality: Modality = Modality.NUMERIC, observation_unit: ObservationUnit = ObservationUnit.SAMPLE, feature_count: int = 0, observation_count: int = 0, has_missing_values: bool = False, metadata: dict[str, Any] = <factory: dict>)

Derived structural description of an observation set.

Signature parameters
Parameter	Type	Default
`ordering`	`Ordering`	`Ordering.UNORDERED`
`temporal_semantics`	`TemporalSemantics`	`TemporalSemantics.NONE`
`grouping`	`Grouping`	`Grouping.SINGLE_POPULATION`
`topology`	`Topology`	`Topology.NONE`
`structure`	`Structure`	`Structure.FLAT`
`modality`	`Modality`	`Modality.NUMERIC`
`observation_unit`	`ObservationUnit`	`ObservationUnit.SAMPLE`
`feature_count`	`int`	`0`
`observation_count`	`int`	`0`
`has_missing_values`	`bool`	`False`
`metadata`	`dict[str, Any]`	`<factory: dict>`

Members

orderingattribute

# DataCharacteristics.ordering Source ↗

ordering: Ordering = Ordering.UNORDERED

temporal_semanticsattribute

# DataCharacteristics.temporal_semantics Source ↗

temporal_semantics: TemporalSemantics = TemporalSemantics.NONE

groupingattribute

# DataCharacteristics.grouping Source ↗

grouping: Grouping = Grouping.SINGLE_POPULATION

topologyattribute

# DataCharacteristics.topology Source ↗

topology: Topology = Topology.NONE

structureattribute

# DataCharacteristics.structure Source ↗

structure: Structure = Structure.FLAT

modalityattribute

# DataCharacteristics.modality Source ↗

modality: Modality = Modality.NUMERIC

observation_unitattribute

# DataCharacteristics.observation_unit Source ↗

observation_unit: ObservationUnit = ObservationUnit.SAMPLE

feature_countattribute

# DataCharacteristics.feature_count Source ↗

feature_count: int = 0

observation_countattribute

# DataCharacteristics.observation_count Source ↗

observation_count: int = 0

has_missing_valuesattribute

# DataCharacteristics.has_missing_values Source ↗

has_missing_values: bool = False

metadataattribute

# DataCharacteristics.metadata Source ↗

metadata: dict[str, Any] = field(default_factory=dict)

is_temporalproperty

# DataCharacteristics.is_temporal Source ↗

is_temporal: bool

Returns bool

is_orderedproperty

# DataCharacteristics.is_ordered Source ↗

is_ordered: bool

Returns bool

is_multivariateproperty

# DataCharacteristics.is_multivariate Source ↗

is_multivariate: bool

Returns bool

has_topologyproperty

# DataCharacteristics.has_topology Source ↗

has_topology: bool

Returns bool

has_hierarchyproperty

# DataCharacteristics.has_hierarchy Source ↗

has_hierarchy: bool

Returns bool

to_dictmethod

# DataCharacteristics.to_dict Source ↗

to_dict() -> dict[str, Any]

Returns dict[str, Any]

classView source ↗

Grouping

Grouping

Bases: str, Enum

Members

SINGLE_POPULATIONattribute

# Grouping.SINGLE_POPULATION Source ↗

SINGLE_POPULATION = 'single_population'

MULTIPLE_ENTITIESattribute

# Grouping.MULTIPLE_ENTITIES Source ↗

MULTIPLE_ENTITIES = 'multiple_entities'

MULTIPLE_SEQUENCESattribute

# Grouping.MULTIPLE_SEQUENCES Source ↗

MULTIPLE_SEQUENCES = 'multiple_sequences'

classView source ↗

Modality

Modality

Bases: str, Enum

Members

NUMERICattribute

# Modality.NUMERIC Source ↗

NUMERIC = 'numeric'

CATEGORICALattribute

# Modality.CATEGORICAL Source ↗

CATEGORICAL = 'categorical'

TEXTattribute

# Modality.TEXT Source ↗

TEXT = 'text'

MIXEDattribute

# Modality.MIXED Source ↗

MIXED = 'mixed'

classView source ↗

ObservationUnit

ObservationUnit

Bases: str, Enum

Members

SAMPLEattribute

# ObservationUnit.SAMPLE Source ↗

SAMPLE = 'sample'

TIMESTEPattribute

# ObservationUnit.TIMESTEP Source ↗

TIMESTEP = 'timestep'

WINDOWattribute

# ObservationUnit.WINDOW Source ↗

WINDOW = 'window'

SEQUENCEattribute

# ObservationUnit.SEQUENCE Source ↗

SEQUENCE = 'sequence'

NODEattribute

# ObservationUnit.NODE Source ↗

NODE = 'node'

EDGEattribute

# ObservationUnit.EDGE Source ↗

EDGE = 'edge'

GRAPHattribute

# ObservationUnit.GRAPH Source ↗

GRAPH = 'graph'

classView source ↗

Ordering

Ordering

Bases: str, Enum

Members

UNORDEREDattribute

# Ordering.UNORDERED Source ↗

UNORDERED = 'unordered'

ORDEREDattribute

# Ordering.ORDERED Source ↗

ORDERED = 'ordered'

classView source ↗

Structure

Structure

Bases: str, Enum

Members

FLATattribute

# Structure.FLAT Source ↗

FLAT = 'flat'

NESTEDattribute

# Structure.NESTED Source ↗

NESTED = 'nested'

HIERARCHICALattribute

# Structure.HIERARCHICAL Source ↗

HIERARCHICAL = 'hierarchical'

classView source ↗

TemporalSemantics

TemporalSemantics

Bases: str, Enum

Members

NONEattribute

# TemporalSemantics.NONE Source ↗

NONE = 'none'

EVENT_TIMEattribute

# TemporalSemantics.EVENT_TIME Source ↗

EVENT_TIME = 'event_time'

REGULAR_TIMEattribute

# TemporalSemantics.REGULAR_TIME Source ↗

REGULAR_TIME = 'regular_time'

IRREGULAR_TIMEattribute

# TemporalSemantics.IRREGULAR_TIME Source ↗

IRREGULAR_TIME = 'irregular_time'

classView source ↗

Topology

Topology

Bases: str, Enum

Members

NONEattribute

# Topology.NONE Source ↗

NONE = 'none'

GRAPH_EDGESattribute

# Topology.GRAPH_EDGES Source ↗

GRAPH_EDGES = 'graph_edges'

SPATIAL_ADJACENCYattribute

# Topology.SPATIAL_ADJACENCY Source ↗

SPATIAL_ADJACENCY = 'spatial_adjacency'