Skip to content

v1.1.0 - Documentation & Stability Release

Latest

Choose a tag to compare

@The-Obstacle-Is-The-Way The-Obstacle-Is-The-Way released this 10 Oct 22:30

πŸš€ NEDC-BENCH v1.1.0 - Documentation & Stability Release

Second production release with comprehensive documentation overhaul and enhanced testing infrastructure.

✨ Highlights

  • Complete Documentation Overhaul β€” Extracted all technical content from archives with 100% detail preservation
  • 11 Critical Bug Fixes β€” Fully documented with evidence, file paths, and completion grades
  • Testing Infrastructure β€” pytest-xdist group markers for robust test isolation
  • Beta Configuration β€” Three-tier architecture with design rationale
  • 100% Parity β€” Validated on 1832 file pairs (preserved from v1.0.0)

πŸ“š Documentation Additions

New Developer Resources

  • bug_fixes_2025.md (835 lines) β€” Complete technical reference for all 11 critical bug fixes

    • Router pattern (Beta/Alpha decoupling)
    • NULL_CLASS separation (DP alignment)
    • Beta config loading (three-tier architecture)
    • Test stability (AsyncIO event loop, race conditions)
  • beta_config.md β€” Three-tier beta configuration architecture

  • beta_config_design.md β€” First-principles validation & design rationale

  • parity.md β€” Complete parity testing documentation (100% on 1832 file pairs)

Enhanced Algorithm Documentation

  • TAES β€” Multi-overlap sequencing details
  • Epoch β€” Sampling boundary documentation
  • IRA β€” Kappa calculation internals
  • DP Alignment β€” NULL sentinel design rationale

πŸ§ͺ Testing Improvements

  • pytest-xdist group markers (`@pytest.mark.xdist_group`) for test isolation
  • Test stability documentation with comprehensive alternative solutions analysis
  • Industry-standard approach using pytest-xdist groups for shared resource management
  • Opt-in parallel execution (moved `--dist=loadgroup` from pyproject.toml to Makefile)

πŸ› Critical Bug Fixes Documented

All 11 bugs fully documented in bug_fixes_2025.md:

ID Issue Grade
P1-1 Beta/Alpha decoupling (router pattern) A+
P1-2 BetaPipelineOrchestrator NULL mutation A
P1-3 Beta config loading (three-tier architecture) A+
P1-4 DP NULL_CLASS separation A+
P1-5 TAES count rounding A
P1-6 Overlap penalty caps A
P1-7 Epoch time boundaries A
P1-8 IRA class handling B+
P2-1 Integration test stability A+
P2-2 Parity validator imports A
P2-3 DP summary mapping A+

πŸ“Š Validation Results (Unchanged)

Perfect parity maintained with NEDC v6.0.0:

```
βœ… TAES: TP=133.84, FP=552.77, Sensitivity=12.45%, FA/24h=30.46
βœ… Epoch: TP=33704, FP=18816, Sensitivity=11.86%, FA/24h=259.23
βœ… Overlap: TP=253, FP=536, Sensitivity=23.53%, FA/24h=29.54
βœ… DP: TP=328, FP=966, Sensitivity=30.51%, FA/24h=53.23
βœ… IRA: Kappa=0.1887 (multi-class Cohen's ΞΊ)
```

πŸ”§ Installation

```bash

Using UV (recommended)

uv pip install nedc-bench==1.1.0

Using pip

pip install nedc-bench==1.1.0

From source

git clone https://github.com/Clarity-Digital-Twin/nedc-bench.git
cd nedc-bench
git checkout v1.1.0
make dev
```

🚦 Quick Start

```bash

Run complete evaluation

python scripts/run_alpha_complete.py

Start API server

uvicorn nedc_bench.api.main:app

Run parity validation

python scripts/ultimate_parity_test.py
```

πŸ“‹ What's Included

βœ… All v1.0.0 features (dual-pipeline, 5 algorithms, FastAPI, Docker)
βœ… Complete documentation with 100% detail preservation
βœ… Enhanced developer resources (bug fixes, architecture, testing guides)
βœ… Test stability improvements (pytest-xdist groups)
βœ… Beta configuration architecture (three-tier design)
βœ… All cross-references verified and working

πŸ“¦ Requirements

  • Python 3.10+
  • NEDC v6.0.0 (vendored)
  • See pyproject.toml for dependencies

πŸ“„ License

Apache 2.0 (new code), Temple University copyright (NEDC v6.0.0)


See CHANGELOG.md for detailed changes.