Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Changelog

## [1.1.0]

### Added
- Personal baseline calibration during the first portion of a session (baseline.py)
- Vocal load impulse response model with acute and chronic load components and recovery time estimation (analytics.py), adapted from the Banister impulse response framework used in sports science
- Exponential moving average smoothing of the raw fatigue score
- Auxiliary acoustic feature extraction (jitter, shimmer, harmonics to noise ratio, CPPS) via Praat/parselmouth
- Automated test suite covering EMA smoothing, impulse response calculations, baseline calibration, acoustic feature extraction, session reporting, CLI, and utility functions
- Continuous integration workflow running the test suite with coverage on every push and pull request to main

### Changed
- Elapsed time for decay calculations is now derived from actual audio samples processed rather than a wall clock, keeping temporal load calculations consistent with session timestamps
- Session records now include per window smoothed score, acute load, chronic load, an experimental readiness metric, recovery ETA, and baseline calibration state, in addition to the raw score
- praat-parselmouth added as a formal project dependency in pyproject.toml, rather than only appearing in requirements.txt

### Fixed
- Backward compatibility maintained for existing callers of SessionAnalytics.add and SessionReport.add_record that do not supply elapsed_seconds
- Acoustic feature extraction failures and a missing parselmouth installation now log a warning instead of failing silently

### Documentation
- README updated to document all additions above, including a corrected architecture diagram, configuration table, and sample session report
- Added CONTRIBUTORS.md and this CHANGELOG.md
2 changes: 2 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Muhammad Khubaib Ahmad, core author, project lead
# Sarib Azim, major contributions for the updated version 1.1.0 under INFERENCE Lab, Core Engineer (Research, Implementation and Evaluation)
10 changes: 7 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
[project]
name = "voiceMonitor"
version = "0.1.0"
version = "1.1.0"
description = "Real-Time Vocal Fatigue Monitoring for Continuous Speech Analytics"
readme = "README.md"
authors = [
{ name="Muhammad Khubaib Ahmad", email="muhammadkhubaibahmad854@gmail.com" }
{ name="Muhammad Khubaib Ahmad", email="khubaib.ahmad@inference-lab.org" }
]
maintainers = [
{ name="INFERENCE Lab" }
]
license = { text="MIT" }

Expand All @@ -14,7 +17,8 @@ dependencies = [
"sounddevice>=0.4",
"pydub>=0.25",
"soundfile>=0.12",
"tqdm>=4.65"
"tqdm>=4.65",
"praat-parselmouth>=0.4"
]

[project.scripts]
Expand Down
Loading