QuantMini

User Guide:

  • Getting Started
    • Prerequisites
    • Installation
      • From Source (Recommended)
    • Configuration
    • Medallion Architecture Overview
    • Quick Start
      • 1. Download Data (Bronze Layer)
        • Option A: Initial Batch Load (First Time)
        • Option B: Incremental Updates (Daily)
        • Option C: Bulk Download (All Data Types)
      • 2. Enrich with Features (Silver Layer)
      • 3. Convert to Qlib Format (Gold Layer)
      • 4. Query and Analyze
    • Next Steps
    • Common Issues
      • Issue: Polygon API rate limits
      • Issue: External drive setup
      • Issue: Missing data
    • Support
  • Installation
    • Requirements
    • Installation Methods
      • From Source (Recommended)
      • External Drive Setup
    • Configuration
      • 1. Credentials
      • 2. Data Storage
    • Verify Installation
    • Dependencies
      • Core Dependencies
      • Optional: ML Dependencies
      • Optional: Development Dependencies
    • Directory Structure
    • Troubleshooting
      • Issue: “Failed to clone files” warning
      • Issue: Virtual environment not working
      • Issue: Import errors
      • Issue: Polygon credentials not found
      • Issue: Data directory not found
    • Next Steps
  • Guides
    • Quickstart
    • Medallion Architecture
    • Batch Downloader
    • Data Loader
    • Alpha158 Features
    • Additional Guides
  • Examples
    • Overview
    • Data Pipeline Examples
    • Polygon REST API Examples
    • Data Loader Examples
    • Qlib Integration Examples
    • Complete Workflow Example
    • Installation
    • Running Examples
    • Additional Resources

API Reference:

  • API Reference
    • Core Modules
      • Core Module (src.core)
        • ConfigLoader
        • Memory Monitoring
        • System Profiling
        • Exceptions
        • Environment Variables
      • Download Module (src.download)
        • AsyncS3Downloader
        • SyncS3Downloader
        • S3Catalog
      • Features Module (src.features)
        • Feature Engineer
        • Feature Definitions
        • Simple Definitions
        • Options Parser
        • Custom Features
      • Transform Module (src.transform)
        • Qlib Binary Writer
        • Qlib Binary Validator
        • Using Qlib Binary Data
        • Incremental Updates
        • Troubleshooting
      • Utils Module (src.utils)
        • Gym Warnings Suppression
        • Complete Example
        • Why This Is Needed
        • All Example Scripts Use This
        • Technical Details
        • Related Documentation
    • Core Infrastructure
      • Core Module (src.core)
        • ConfigLoader
        • Memory Monitoring
        • System Profiling
        • Exceptions
        • Environment Variables
    • Polygon REST API Integration
      • Download Module (src.download)
        • AsyncS3Downloader
        • SyncS3Downloader
        • S3Catalog
    • Feature Engineering
      • Features Module (src.features)
        • Feature Engineer
        • Feature Definitions
        • Simple Definitions
        • Options Parser
        • Custom Features
    • Data Transformation
      • Transform Module (src.transform)
        • Qlib Binary Writer
        • Qlib Binary Validator
        • Using Qlib Binary Data
        • Incremental Updates
        • Troubleshooting
    • Utilities
      • Utils Module (src.utils)
        • Gym Warnings Suppression
        • Complete Example
        • Why This Is Needed
        • All Example Scripts Use This
        • Technical Details
        • Related Documentation
    • Module Overview
    • Data Pipeline Architecture
    • External Documentation

About:

  • Changelog
    • [Unreleased]
      • Added (2025-10-18)
      • Changed (2025-10-18)
      • Core Modules (Current)
      • Data Coverage
      • Infrastructure
    • 0.1.0 - 2024-09-30
      • Added
      • Core Modules (v0.1.0)

Development:

  • Contributing to QuantMini
    • Getting Started
    • Development Workflow
      • 1. Create a Branch
      • 2. Make Changes
      • 3. Test Your Changes
      • 4. Commit Your Changes
      • 5. Push and Create Pull Request
    • Code Style
      • Python Style
      • Example
      • Documentation
    • Testing
      • Writing Tests
      • Example Test
    • Architecture Guidelines
      • Medallion Architecture Layers
      • Data Partitioning
      • Async Best Practices
    • Documentation
      • Adding Documentation
      • Building Documentation Locally
    • Pull Request Guidelines
      • Before Submitting
      • Pull Request Description
      • Example PR Description
    • Reporting Issues
      • Bug Reports
      • Feature Requests
    • Code Review Process
    • Project Structure
    • Questions?
    • License
  • Changelog
    • [Unreleased]
      • Added (2025-10-18)
      • Changed (2025-10-18)
      • Core Modules (Current)
      • Data Coverage
      • Infrastructure
    • 0.1.0 - 2024-09-30
      • Added
      • Core Modules (v0.1.0)
QuantMini
  • Search

© Copyright 2025, Zheyuan Zhao.

Built with Sphinx using a theme provided by Read the Docs.