docs

NEDC-BENCH Documentation

Overview

Complete documentation for NEDC-BENCH - a production-ready EEG benchmarking platform with 100% parity to NEDC v6.0.0.

Documentation Structure

📚 Getting Started

• installation.md - How to install NEDC-BENCH
• quickstart.md - 5-minute guide to get running

👤 User Guide

• user-guide/ - Complete user documentation
  • Overview, algorithms, input/output formats, API usage

🔌 API Documentation

• api/ - REST API and WebSocket documentation
  • OpenAPI spec, endpoints, examples, Python client

🧑‍💻 Developer Guide

• developer/ - For contributors and developers
  • Architecture, testing, code style, debugging
  • Beta configuration and design details
  • 2025 bug fixes

🧮 Algorithm Reference

• algorithms/ - Detailed algorithm specifications
  • TAES, Epoch, Overlap, DP Alignment, IRA, metrics

🚀 Deployment

• deployment/ - Production deployment guides
  • Docker, Kubernetes, configuration, monitoring, scaling

📖 Reference

• reference/ - Complete reference material
  • Configuration, CLI, API reference, glossary, FAQ, Parity Status

🔄 Migration

• migration/ - Migration and upgrade guides
  • From NEDC v6.0.0, version upgrades, data format conversion

📦 Archive

• archive/ - Historical documentation (being migrated)
  • Use the Archive Migration Plan to track what has already been folded into the main docs.
  • Legacy parity histories, bug investigations, and phased implementation notes remain here until migration is complete.

Quick Links

• Project README
• Installation Guide
• API Documentation
• Algorithm Guide
• Docker Deployment

Documentation Status

• Algorithms, API, developer, migration, and reference sections are complete and current.
• Deployment, installation, and quickstart guides provide practical, verified steps.

Last updated: 2025-10-10