NCAA Eval Documentation

User Guide:

• User Guide
  • Getting Started
  • Evaluation Metrics
  • Model Types
  • Interpreting Results
  • Tournament Simulation
  • Tournament Scoring
  • Dashboard Guide
  • Troubleshooting

Tutorials:

• Getting Started Tutorial
  • Step 1: Sync Data
  • Step 2: Train an Elo Model
  • Step 3: Train an XGBoost Model
  • Step 4: Launch the Dashboard
  • Step 5: Interpret Your Results
  • Step 6: Iterate and Improve
  • Next Steps
• How to Create a Custom Model
  • Prerequisites
  • Part 1: Stateless Model (Feature-Based)
  • Part 2: Stateful Model (Rating-Based)
  • Running Evaluation with a Custom Model
  • Summary
  • Next Steps
• How to Add a Custom Metric
  • Prerequisites
  • Part 1: Custom Metric Function
  • Part 2: Custom Tournament Scoring Rule
  • Summary
  • Next Steps

Developer Guides:

• NCAA Eval Style Guide
  • 1. Docstring Convention (Google Style)
  • 2. Naming Conventions
  • 3. Import Ordering
  • 4. Type Annotation Standards
  • 5. Vectorization First
  • 6. Design Philosophy (PEP 20 - The Zen of Python)
  • 7. PR Checklist (Summary)
  • 8. File & Module Organization
  • 9. Additional Architecture Rules
  • 10. SOLID Principles for Testability
  • 11. Quality Gate Architecture
  • References
• Testing Strategy
  • Table of Contents
  • Overview
  • Detailed Guides
  • Quick Decision Trees
  • Test Markers Reference
  • Test Commands Reference
  • Test Organization
  • Coverage Targets
  • Testing Tools
  • Domain-Specific Testing
  • References

Testing Guides:

• Testing Conventions
• Domain-Specific Testing
• Test Execution Tiers
• Test Suite Quality Assurance
• Test Approach Guide: Example-Based vs Property-Based vs Fuzz-Based Testing
• Test Purpose Guide: Functional, Performance, and Regression Testing
• Test Scope Guide: Unit vs Integration Tests

API Reference:

• ncaa_eval
  • ncaa_eval package

Indices and tables

• Index

• Module Index