collate_hyper_edge_sets

collate_hyper_edge_sets(hyper_edge_set_list)[source]

Collate a list of HyperEdgeSet into a single batched HyperEdgeSet.

Each HyperEdgeSet in the input list is assumed to have the same feature and port schema. This function stacks the per-edge attributes along the 0-th axis.

Parameters:

hyper_edge_set_list (list[HyperEdgeSet]) – Sequence of HyperEdgeSet objects to batch together. Must be non-empty.

Returns:

A single batched HyperEdgeSet.

Raises:
  • IndexError – Raised if hyper_edge_set_list is empty.

  • ValueError – Raised if not all HyperEdgeSet share the same keys in port_names or feature_names.

Return type:

HyperEdgeSet