Reference

Below is a comprehensive overview of the ash_model API organized by module.

Classes

This module contains the core classes used in the ASH model. Specifically, it includes the ASH class to represent the model itself, and the NProfile class for node profiles.

Measures

This section includes various measures that can be computed on ASH models.

MultiEgo

This module provides functions for multi-ego network analysis, including core identification, similarity measures, and fracture analysis.

Generators

This module provides functions to generate synthetic ASH models with specific properties, such as random hypergraphs or hypergraphs with controlled attribute homogeneity.

Paths and Walks

This module includes pathfinding and random walk generation algorithms for ASH models. Notably, it includes s-walks and time-respecting walks.

I/O

This module provides functions to import/export ASH models from/to JSON, CSV, and HIF.

Utils

This module provides various utility functions for working with ASH models, including matrix transformations, projections, networkx conversions, and profile manipulations.

Visualization