MODULE REFERENCE

relations

anomx.data.base.relations

Optional relational overlays for observation sets.

Graphs and hierarchies are not separate top-level dataset types. They are additional structural dimensions that can be attached to any ObservationSet and consumed by views or models that support them.

classView source ↗

Hierarchy

Hierarchy(links: pd.DataFrame, child_column: str = 'child', parent_column: str = 'parent', metadata: dict[str, Any] = <factory: dict>)

Parent-child relationships between entities.

Signature parameters
Parameter	Type	Default
`links`	`pd.DataFrame`	`required`
`child_column`	`str`	`'child'`
`parent_column`	`str`	`'parent'`
`metadata`	`dict[str, Any]`	`<factory: dict>`

Members

linksattribute

# Hierarchy.links Source ↗

links: pd.DataFrame

child_columnattribute

# Hierarchy.child_column Source ↗

child_column: str = 'child'

parent_columnattribute

# Hierarchy.parent_column Source ↗

parent_column: str = 'parent'

metadataattribute

# Hierarchy.metadata Source ↗

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

parent_ofmethod

# Hierarchy.parent_of Source ↗

parent_of(child: Any) -> Any | None

Signature parameters
Parameter	Type	Default
`child`	`Any`	`required`

Returns Any | None

children_ofmethod

# Hierarchy.children_of Source ↗

children_of(parent: Any) -> list[Any]

Signature parameters
Parameter	Type	Default
`parent`	`Any`	`required`

Returns list[Any]

rootsmethod

# Hierarchy.roots Source ↗

roots() -> list[Any]

Returns list[Any]

classView source ↗

RelationSet

RelationSet(edges: pd.DataFrame, source_column: str = 'source', target_column: str = 'target', weight_column: str | None = None, metadata: dict[str, Any] = <factory: dict>)

Edge list connecting observations or entities.

Signature parameters
Parameter	Type	Default
`edges`	`pd.DataFrame`	`required`
`source_column`	`str`	`'source'`
`target_column`	`str`	`'target'`
`weight_column`	`str \| None`	`None`
`metadata`	`dict[str, Any]`	`<factory: dict>`

Members

edgesattribute

# RelationSet.edges Source ↗

edges: pd.DataFrame

source_columnattribute

# RelationSet.source_column Source ↗

source_column: str = 'source'

target_columnattribute

# RelationSet.target_column Source ↗

target_column: str = 'target'

weight_columnattribute

# RelationSet.weight_column Source ↗

weight_column: str | None = None

metadataattribute

# RelationSet.metadata Source ↗

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

edge_countproperty

# RelationSet.edge_count Source ↗

edge_count: int

Returns int

neighborsmethod

# RelationSet.neighbors Source ↗

neighbors(node: Any) -> list[Any]

Signature parameters
Parameter	Type	Default
`node`	`Any`	`required`

Returns list[Any]