Understanding the Architecture

This section explains the PyPOTS architecture from the ground up. Read these pages in order if you are new to the codebase.

• Codebase Map and Folder Intent
  • Repository Overview
  • Core Directories Explained
  • Template Directories
  • Three Example Folders Worth Reading First
  • Dependency Direction
  • Module Boundary Rules
• Base Classes and Inheritance
  • The Inheritance Stack
  • What Each Layer Owns
  • BaseModel: The Outer Shell
  • BaseNNModel: The Training-Loop Contract
  • ModelCore: The NN Core Base
  • BaseDataset: The Default Sample Contract
  • Task-Specific NN Differences
  • Example Mapping
• Data Flow and Dataset Contracts
  • The Normal Data Flow
  • What BaseDataset Returns
  • What Each Stage Should Assemble
  • SAITS: A Concrete Data Flow Example
  • When You Need a Custom Dataset
  • Data Input Formats
  • Fast Debugging Checklist