topobench.transforms.feature_liftings package

Submodules

topobench.transforms.feature_liftings.concatenation module

Concatenation feature lifting.

class topobench.transforms.feature_liftings.concatenation.Concatenation(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by concatenation.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Concatenate r-cell features to obtain r+1-cell features.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

topobench.transforms.feature_liftings.identity module

Identity transform that does nothing to the input data.

class topobench.transforms.feature_liftings.identity.Identity(**kwargs)

Bases: BaseTransform

An identity transform that does nothing to the input data.

Parameters:

**kwargsoptional

Parameters for the base transform.

forward(data: Data)

Apply the transform to the input data.

Parameters:

datatorch_geometric.data.Data

The input data.

Returns:

torch_geometric.data.Data

The same data.

topobench.transforms.feature_liftings.projection_sum module

ProjectionSum class.

class topobench.transforms.feature_liftings.projection_sum.ProjectionSum(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by projection.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Project r-cell features of a graph to r+1-cell structures.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The data with the lifted features.

topobench.transforms.feature_liftings.set module

Set lifting for r-cell features to r+1-cell features.

class topobench.transforms.feature_liftings.set.Set(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by set operations.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Concatenate r-cell features to r+1-cell structures.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

Module contents

Feature lifting transforms with automated exports.

class topobench.transforms.feature_liftings.Concatenation(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by concatenation.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Concatenate r-cell features to obtain r+1-cell features.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

class topobench.transforms.feature_liftings.Identity(**kwargs)

Bases: BaseTransform

An identity transform that does nothing to the input data.

Parameters:

**kwargsoptional

Parameters for the base transform.

forward(data: Data)

Apply the transform to the input data.

Parameters:

datatorch_geometric.data.Data

The input data.

Returns:

torch_geometric.data.Data

The same data.

class topobench.transforms.feature_liftings.ProjectionSum(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by projection.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Project r-cell features of a graph to r+1-cell structures.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The data with the lifted features.

class topobench.transforms.feature_liftings.Set(**kwargs)

Bases: BaseTransform

Lift r-cell features to r+1-cells by set operations.

Parameters:

**kwargsoptional

Additional arguments for the class.

forward(data: Data | dict) → Data | dict

Apply the lifting to the input data.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.

lift_features(data: Data | dict) → Data | dict

Concatenate r-cell features to r+1-cell structures.

Parameters:

datatorch_geometric.data.Data | dict

The input data to be lifted.

Returns:

torch_geometric.data.Data | dict

The lifted data.