API Reference

Complete API documentation for torchTextClassifiers, auto-generated from source code docstrings.

Overview

The API is organized into several modules:

• torchTextClassifiers Wrapper - High-level torchTextClassifiers wrapper class

• Configuration Classes - Configuration classes (ModelConfig, TrainingConfig)

• Tokenizers - Text tokenization (NGram, WordPiece, HuggingFace)

• Model Components - Model components (TextEmbedder, CategoricalVariableNet, etc.)

• Core Models - Core PyTorch models

• Dataset - Dataset classes for data loading

Quick Links

Most Used Classes

• torchTextClassifiers.torchTextClassifiers.torchTextClassifiers - Main wrapper class

• torchTextClassifiers.torchTextClassifiers.ModelConfig - Model configuration

• torchTextClassifiers.torchTextClassifiers.TrainingConfig - Training configuration

• torchTextClassifiers.tokenizers.WordPieceTokenizer - WordPiece tokenizer

• torchTextClassifiers.tokenizers.NGramTokenizer - N-gram tokenizer

Architecture Components

• torchTextClassifiers.model.components.TextEmbedder - Text embedding layer

• torchTextClassifiers.model.components.CategoricalVariableNet - Categorical features

• torchTextClassifiers.model.components.ClassificationHead - Classification layer

• torchTextClassifiers.model.components.Attention.AttentionConfig - Attention configuration

Core Models

• torchTextClassifiers.model.model.TextClassificationModel - Core PyTorch model

• torchTextClassifiers.model.lightning.TextClassificationModule - PyTorch Lightning module

• torchTextClassifiers.dataset.dataset.TextClassificationDataset - PyTorch Dataset

Module Documentation

• torchTextClassifiers Wrapper
  • Main Class
  • Usage Example
  • See Also
• Configuration Classes
  • ModelConfig
  • TrainingConfig
  • See Also
• Tokenizers
  • Base Classes
  • Concrete Tokenizers
  • Choosing a Tokenizer
  • Tokenizer Comparison
  • See Also
• Model Components
  • Text Embedding
  • Categorical Features
  • Classification Head
  • Attention Mechanism
  • Composing Components
  • See Also
• Core Models
  • PyTorch Model
  • PyTorch Lightning Module
  • Training Steps
  • Custom Training
  • See Also
• Dataset
  • TextClassificationDataset
  • Parameters
  • Example Usage
  • DataLoader Integration
  • Batch Format
  • Custom Collation
  • Memory Considerations
  • See Also

Indices

• Index

• Module Index

• Search Page