API Reference

This section provides detailed API documentation for SeisPolarity modules.

Modules

Dataset API - WaveformDataset and data loading utilities
Model API - Pretrained models and model utilities
Training API - Training utilities and configuration
Augmentation API - Data augmentation classes

Package Structure

seispolarity/
├── __init__.py              # Main package entry point
├── dataset/                 # Dataset loading and utilities
│   ├── __init__.py
│   ├── dataset.py          # WaveformDataset class
│   ├── utils.py            # Dataset utilities
│   └── huggingface.py      # Hugging Face integration
├── models/                  # Model architectures
│   ├── __init__.py
│   ├── ross.py             # Ross model
│   ├── eqpolarity.py       # Eqpolarity model
│   ├── ditingmotion.py     # DiTingMotion model
│   ├── cfm.py              # CFM model
│   ├── rpnet.py            # RPNet model
│   ├── polarcap.py         # PolarCAP model
│   └── app.py              # APP model
├── training/                # Training utilities
│   ├── __init__.py
│   ├── trainer.py          # Trainer class
│   └── config.py           # TrainingConfig class
└── generate/                # Data generation and augmentation
    ├── __init__.py
    ├── generator.py        # Generator classes
    └── augmentation.py     # Augmentation classes

Quick Links

Data Loading

Models

Training

Augmentation

Utility Functions

get_dataset_path

configure_cache

get_hf_path

Exceptions

Version Information

import seispolarity

print(seispolarity.__version__)