API Reference

PELICAN Network

pelican.nets.PELICAN(in_channels_rank2, ...)

PELICAN network.

Permutation-equivariant layers

pelican.layers.PELICANBlock(hidden_channels)	PELICAN edge-to-edge aggregation block.
pelican.layers.Aggregator2to2(in_channels, ...)	Aggregator from edges (rank 2) to edges (rank 2).
pelican.layers.Aggregator2to1(in_channels, ...)	Aggregator from edges (rank 2) to nodes (rank 1).
pelican.layers.Aggregator2to0(in_channels, ...)	Aggregator from edges (rank 2) to graph (rank 0).
pelican.layers.Aggregator1to2(in_channels, ...)	Aggregator from nodes (rank 1) to edges (rank 2).
pelican.layers.Aggregator0to2(in_channels, ...)	Aggregator from graph (rank 0) to edges (rank 2).
pelican.layers.GeneralAggregator(aggregator, ...)	General aggregator class.

Permutation-equivariant aggregators

pelican.primitives.aggregate_0to2(graph, ...)	Aggregate from graph (rank 0) to edges (rank 2).
pelican.primitives.aggregate_1to2(nodes, ...)	Aggregate from nodes (rank 1) to edges (rank 2).
pelican.primitives.aggregate_2to0(edges, ...)	Aggregate from edges (rank 2) to graph (rank 0).
pelican.primitives.aggregate_2to1(edges, ...)	Aggregate from edges (rank 2) to nodes (rank 1).
pelican.primitives.aggregate_2to2(edges, ...)	Aggregate from edges (rank 2) to edges (rank 2).