jittor_geometric.nn.aggr

Aggregation functions.

class jittor_geometric.nn.aggr.Aggregation

Bases: Module

__init__()

execute(x, index=None, ptr=None, dim_size=None, dim=-2, max_num_elements=None)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

• max_num_elements (Optional[int])

Return type:

Var

reset_parameters()

Resets all learnable parameters of the module.

assert_index_present(index)

Parameters:

index (Optional[Var])

assert_sorted_index(index)

Parameters:

index (Optional[Var])

assert_two_dimensional_input(x, dim)

Parameters:

• x (Var)

• dim (int)

reduce(x, index=None, ptr=None, dim_size=None, dim=-2, reduce='sum')

Perform the aggregation (sum, max, mean, etc.).

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

• reduce (str)

Return type:

Var

segment(x, ptr, reduce='sum')

Segment operation using ptr, similar to torch_scatter.segment.

Parameters:

• x (Var)

• ptr (Var)

• reduce (str)

Return type:

Var

to_dense_batch(x, index=None, ptr=None, dim_size=None, dim=-2, fill_value=0.0, max_num_elements=None)

Converts the aggregation input into a dense batch.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

• fill_value (float)

• max_num_elements (Optional[int])

Return type:

Tuple[Var, Var]

to_dense_batch_helper(x, index, dim_size, fill_value)

Helper function for creating dense batches.

Parameters:

• x (Var)

• index (Var)

• dim_size (Optional[int])

• fill_value (float)

Return type:

Tuple[Var, Var]

class jittor_geometric.nn.aggr.MultiAggregation(aggrs, aggrs_kwargs=None, mode='cat', mode_kwargs=None)

Bases: Module

Performs aggregations with one or more aggregators and combines aggregated results, as described in the “Principal Neighbourhood Aggregation for Graph Nets” and “Adaptive Filters and Aggregator Fusion for Efficient Graph Convolutions” papers.

Parameters:

• aggrs (list) – The list of aggregation schemes to use.

• aggrs_kwargs (dict, optional) – Arguments passed to the respective aggregation function in case it gets automatically resolved. (default: None).

• mode (str, optional) – The combine mode to use for combining aggregated results from multiple aggregations. (default: "cat").

• mode_kwargs (dict, optional) – Arguments passed for the combine mode. (default: None).

__init__(aggrs, aggrs_kwargs=None, mode='cat', mode_kwargs=None)

Parameters:

• aggrs (List[Union[str, Module]])

• aggrs_kwargs (Optional[List[Dict[str, Any]]])

• mode (Optional[str])

• mode_kwargs (Optional[Dict[str, Any]])

reset_parameters()

get_out_channels(in_channels)

Parameters:

in_channels (int)

Return type:

int

execute(x, index=None, ptr=None, dim_size=None, dim=-2)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

Return type:

Var

combine(inputs)

Parameters:

inputs (List[Var])

Return type:

Var

class jittor_geometric.nn.aggr.SumAggregation

Bases: Aggregation

An aggregation operator that sums up features across a set of elements.

\[\mathrm{sum}(\mathcal{X}) = \sum_{\mathbf{x}_i \in \mathcal{X}} \mathbf{x}_i.\]

execute(x, index=None, ptr=None, dim_size=None, dim=-2)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

Return type:

Var

class jittor_geometric.nn.aggr.MeanAggregation

Bases: Aggregation

An aggregation operator that averages features across a set of elements.

\[\mathrm{mean}(\mathcal{X}) = \frac{1}{|\mathcal{X}|} \sum_{\mathbf{x}_i \in \mathcal{X}} \mathbf{x}_i.\]

execute(x, index=None, ptr=None, dim_size=None, dim=-2)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

Return type:

Var

class jittor_geometric.nn.aggr.MaxAggregation

Bases: Aggregation

An aggregation operator that takes the feature-wise maximum across a set of elements.

\[\mathrm{max}(\mathcal{X}) = \max_{\mathbf{x}_i \in \mathcal{X}} \mathbf{x}_i.\]

execute(x, index=None, ptr=None, dim_size=None, dim=-2)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

Return type:

Var

class jittor_geometric.nn.aggr.MinAggregation

Bases: Aggregation

An aggregation operator that takes the feature-wise minimum across a set of elements.

\[\mathrm{min}(\mathcal{X}) = \min_{\mathbf{x}_i \in \mathcal{X}} \mathbf{x}_i.\]

execute(x, index=None, ptr=None, dim_size=None, dim=-2)

Executes the module computation.

Raises NotImplementedError if the subclass does not override the method.

Parameters:

• x (Var)

• index (Optional[Var])

• ptr (Optional[Var])

• dim_size (Optional[int])

• dim (int)

Return type:

Var