Skip to content

Add CI + real unit tests, decouple metrics, trim doc cruft - #1

Merged
souardis merged 1 commit into
mainfrom
chore/add-ci-tests-and-trim
Jun 19, 2026
Merged

Add CI + real unit tests, decouple metrics, trim doc cruft#1
souardis merged 1 commit into
mainfrom
chore/add-ci-tests-and-trim

Conversation

@souardis

@souardis souardis commented Jun 19, 2026

Copy link
Copy Markdown
Owner

Turns the benchmark into a tested, CI-backed repo and removes auto-generated documentation noise.

Added

  • CI (.github/workflows/ci.yml): ruff + black + pytest on Python 3.13 via uv. Verified green locally.
  • Unit tests (tests/test_metrics.py): 8 deterministic tests for calculate_wer / summarize_errors / normalize_text — no API key required.

Fixed

  • metrics.py import side-effect: config.py raises at import time when AZURE_API_KEY is unset, which made the pure metric functions un-importable (and untestable). Moved config/llm_normalization imports into the one function that needs them.
  • pyproject: real description (was "Add your description here"), dev deps, pytest pythonpath/testpaths config.

Removed

  • REFACTORING_SUMMARY.md and MODULE_DEPENDENCIES.md (transient/auto-generated docs)
  • src/test_models_old.py (dead pre-refactor module)

- Add GitHub Actions CI (ruff + black + pytest on 3.13 via uv)
- Add unit tests for WER/error metrics (8 tests, no API needed)
- Lazy-import config/llm in metrics so pure functions are importable without an API key
- Remove transient docs (REFACTORING_SUMMARY.md, MODULE_DEPENDENCIES.md) and dead test_models_old.py
- Fix placeholder package description; add dev deps + pytest config (pythonpath/testpaths)
- ruff + black clean
@souardis
souardis force-pushed the chore/add-ci-tests-and-trim branch from 5d81f66 to c39d32e Compare June 19, 2026 13:47
@souardis
souardis merged commit f5b75c8 into main Jun 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants