API Reference#
Welcome to the TopoBench API documentation. This section provides detailed documentation for all modules, classes, and functions in the TopoBench package.
The documentation is organized following the package structure for easy navigation.
Package Overview#
- topobench package - Core Package
Main TopoBench package and entry points (1 submodules)
- topobench.callbacks package - Callbacks
Training callbacks for monitoring and control (1 submodules)
- topobench.data package - Data
Dataset loading, preprocessing, and utilities (29 submodules)
- topobench.dataloader package - Data Loaders
Data loading utilities and batch processing (3 submodules)
- topobench.evaluator package - Evaluators
Model evaluation metrics and tools (4 submodules)
- topobench.loss package - Loss Functions
Loss functions for training topological models (7 submodules)
- topobench.model package - Models
Model definitions and architectures (1 submodules)
- topobench.nn package - Neural Networks
Neural network components: backbones, encoders, readouts, and wrappers (48 submodules)
- topobench.optimizer package - Optimizers
Optimization algorithms and schedulers (2 submodules)
- topobench.transforms package - Transformations
Data transformations and topological lifting operations (68 submodules)
- topobench.utils package - Utilities
Helper functions and utility modules (6 submodules)
Detailed Documentation#
Core Package#
Main TopoBench package and entry points
Callbacks#
Training callbacks for monitoring and control
Data#
Dataset loading, preprocessing, and utilities
Data Loaders#
Data loading utilities and batch processing
Evaluators#
Model evaluation metrics and tools
Loss Functions#
Loss functions for training topological models
Models#
Model definitions and architectures
Neural Networks#
Neural network components: backbones, encoders, readouts, and wrappers
Optimizers#
Optimization algorithms and schedulers
Transformations#
Data transformations and topological lifting operations
Utilities#
Helper functions and utility modules