API Reference

TorchFX provides a comprehensive API for audio signal processing with PyTorch.

Modules

• Core Classes
  • Wave
  • FX
• Filters
  • Base Classes
  • FIR Filters
  • IIR Filters
• Effects
  • Gain and Normalization
  • Time-based Effects
• Validation
  • Overview
  • Exception Hierarchy
  • Validator Functions
  • Constants
  • Usage Examples
• Logging
  • Overview
  • Quick Start
  • Configuration Functions
  • Performance Logging
  • Constants
  • Usage Examples
  • Logger Hierarchy
• Real-Time Processing
  • Overview
  • Quick Start
  • Configuration
  • Audio Backend
  • Ring Buffer
  • Processors
  • Exceptions
  • Usage Examples

Overview

The library is organized into six main modules:

• Core (Core Classes) - Base classes Wave and FX

• Filters (Filters) - IIR and FIR filters for audio processing

• Effects (Effects) - Built-in audio effects like Reverb and Delay

• Validation (Validation) - Custom exceptions and parameter validation utilities

• Logging (Logging) - Structured logging and performance profiling

• Real-Time (Real-Time Processing) - Real-time audio I/O, ring buffering, and stream processing

Quick Start

Import the main classes:

from torchfx import Wave, FX
from torchfx.filter import LoButterworth
from torchfx.effect import Reverb
from torchfx.validation import TorchFXError, validate_sample_rate
from torchfx.logging import enable_debug_logging, log_performance

For detailed documentation of each module, see the sections below.