Update README.md

README.md

@@ -1,3 +1,156 @@
----
-license: mit
----
+---
+license: mit
+---
+
+
+
+# Pitch Detection Algorithm Benchmark Report
+
+## Benchmark Methodology
+
+### Evaluation Setup
+This benchmark evaluates pitch detection algorithms across multiple datasets with different characteristics, including synthetic and real audio from speech and music domains. Each algorithm is tested on noisy audio generated by mixing clean datasets with CHiME background noise at various signal-to-noise ratios (10-30 dB) and voice gain variations (-6 to +6 dB).
+
+### Performance Metric Definition
+The **Overall Performance Rankings** show the **Harmonic Mean (HM)** score as percentages, computed from six complementary components:
+
+**HM = 6 / (1/RPA + 1/CA + 1/P + 1/R + 1/OA + 1/GEA)**
+
+Where:
+- **RPA** (Raw Pitch Accuracy): Fraction of voiced frames within 50 cents of ground truth
+- **CA** (Cents Accuracy): exp(-mean_cents_error/500), penalizing larger deviations exponentially
+- **P** (Voicing Precision): TP/(TP+FP), fraction of predicted voiced frames that are truly voiced
+- **R** (Voicing Recall): TP/(TP+FN), fraction of truly voiced frames detected
+- **OA** (Octave Accuracy): exp(-10×octave_error_rate), robustness against octave errors
+- **GEA** (Gross Error Accuracy): exp(-5×gross_error_rate), penalizing deviations >200 cents
+
+### Speed Benchmark Details
+CPU timing measurements are performed on 1-second audio signals at 22.05 kHz sample rate with 256-sample hop length. The reported **CPU Time (ms)** represents the average processing time per 1-second audio segment across multiple runs. **Relative Speed** shows performance relative to CREPE as the baseline algorithm.
+
+### Optimal Threshold Analysis
+The **Optimal Threshold** refers to the voicing confidence threshold that maximizes the Harmonic Mean score. Algorithms test multiple thresholds (0.0 to 1.0 in steps of 0.1) and select the one yielding the highest combined score. **CV** stands for Coefficient of Variation (std/mean), measuring consistency across datasets.
+
+## Dataset Descriptions
+
+The benchmark evaluates algorithms across diverse datasets covering speech, music, synthetic, and real-world conditions:
+
+| **Dataset** | **Domain** | **Type** | **Description** |
+|---|---|---|---|
+| **NSynth** | Music | Synthetic | Single-note synthetic audio from musical instruments with accurate pitch labels. Lacks temporal/spectral complexity of real-world environments. |
+| **PTDB** | Speech | Real | Speech recordings with laryngograph signals capturing vocal fold vibrations. Ground truth derived from high-pass filtered laryngograph signals processed with RAPT algorithm. |
+| **PTDBNoisy** | Speech | Real | Subset of 347 PTDB files (7.4%) with noticeable noise that were excluded from main evaluation. |
+| **MIR1K** | Music | Real | Vocal excerpts with pitch contours initially extracted algorithmically (e.g., YIN) followed by manual correction. Labels still reflect some algorithmic biases. |
+| **MDBStemSynth** | Music | Synthetic | Musically structured synthetic audio with accurate pitch annotations. Valuable for controlled evaluation but lacks real-world acoustic variability. |
+| **Vocadito** | Music | Real | Solo vocal recordings with pitch annotations derived from pYIN algorithm, refined through manual verification process. |
+| **Bach10Synth** | Music | Synthetic | High-quality pitch labels for synthesized musical performances. Similar to MDB-STEM-Synth but focused on Bach compositions. |
+| **SpeechSynth** | Speech | Synthetic | Synthetic Mandarin speech generated using LightSpeech TTS model. Trained on 97.48 hours from AISHELL-3 and Biaobei datasets, providing exact pitch ground truth. |
+
+**Key Characteristics:**
+- **Synthetic datasets** provide perfect ground truth but may lack real-world complexity
+- **Real datasets** capture natural acoustic variations but have imperfect ground truth annotations
+- **Speech datasets** focus on vocal pitch tracking challenges
+- **Music datasets** encompass instrumental and vocal music scenarios
+- **SpeechSynth** addresses the gap of lacking synthetic speech data with accurate pitch labels
+
+## Overall Performance Rankings
+
+| **Algorithm** | **Bach10Synth** | **MDBStemSynth** | **MIR1K** | **PTDB** | **PTDBNoisy** | **SpeechSynth** | **Vocadito** | **Average** |
+|---|---|---|---|---|---|---|---|---|
+| **HPA_RMVPE_76000** | **99.0%** | **94.0%** | **95.9%** | **92.5%** | **84.3%** | 87.6% | 97.0% | **92.9%** |
+| HPA_RMVPE | 98.7% | 93.4% | 95.8% | 91.7% | 83.2% | 86.8% | 96.9% | 92.4% |
+| RMVPE | 98.3% | 91.7% | **96.0%** | 86.0% | 66.6% | **90.5%** | **97.2%** | 89.5% |
+
+No speed benchmark results found.
+## Detailed Performance Analysis
+
+### Voicing Detection Performance
+Measures how well algorithms distinguish between voiced (pitched) and unvoiced (unpitched) audio segments.
+
+| **Algorithm** | **Precision ↑** | **Recall ↑** | **F1-Score ↑** |
+|---|---|---|---|
+| HPA_RMVPE | 0.924 | 0.847 | 0.882 |
+| **HPA_RMVPE_76000** | **0.926** | **0.866** | **0.893** |
+| RMVPE | 0.891 | 0.816 | 0.851 |
+
+### Pitch Accuracy Metrics
+Detailed pitch estimation accuracy across different error types and magnitudes.
+
+| **Algorithm** | **RPA ↑** | **RCA ↑** | **Cents Error ↓** | **RMSE (Hz) ↓** | **Octave Error ↓** | **Gross Error ↓** |
+|---|---|---|---|---|---|---|
+| HPA_RMVPE | 0.909 | 0.910 | 22.7 | 10.0 | 0.004 | 0.007 |
+| HPA_RMVPE_76000 | **0.915** | **0.915** | **21.7** | **9.3** | **0.003** | **0.007** |
+| RMVPE | 0.901 | 0.905 | 32.2 | 13.3 | 0.011 | 0.014 |
+
+**Additional Metric Definitions:**
+- **RCA** (Raw Chroma Accuracy): Fraction with correct pitch class (note name), ignoring octave
+- **Cents Error**: Mean absolute pitch deviation in cents (raw error, before exponential transform used in CA)
+- **RMSE**: Root Mean Square Error in Hz
+
+### Pitch Contour Smoothness
+Measures the temporal stability and continuity of pitch tracks.
+
+| **Algorithm** | **Relative Smoothness ↓** | **Continuity Breaks ↓** | **Overall Smoothness Rank ↓** |
+|---|---|---|---|
+| **RMVPE** | **1.327** | **0.866** | **1.0** |
+| HPA_RMVPE | 1.421 | 0.931 | 2.5 |
+| HPA_RMVPE_76000 | 1.569 | 0.903 | 2.5 |
+
+**Metric Definitions:**
+- **Relative Smoothness**: Coefficient of variation of consecutive pitch changes (std/mean of relative frame-to-frame changes)
+- **Continuity Breaks**: Fraction of ground-truth voiced segments where predicted voicing has gaps
+- **Overall Smoothness Rank**: Average rank across both smoothness metrics (1=best, lower is better)
+
+### Optimal Threshold Analysis
+Voicing confidence thresholds that maximize overall performance scores.
+
+| **Algorithm** | **Mean Threshold** | **Std Dev ↓** | **Range** |
+|---|---|---|---|
+| HPA_RMVPE | 0.486 | **0.064** | 0.40-0.60 |
+| HPA_RMVPE_76000 | 0.443 | 0.090 | 0.30-0.60 |
+| RMVPE | 0.686 | **0.064** | 0.60-0.80 |
+
+### Algorithm Consistency
+Measures performance stability across different datasets using Coefficient of Variation (CV = std/mean).
+
+| **Algorithm** | **Performance CV ↓** | **Threshold CV ↓** |
+|---|---|---|
+| HPA_RMVPE | 0.056 | 0.132 |
+| HPA_RMVPE_76000 | **0.052** | 0.204 |
+| RMVPE | 0.113 | **0.093** |
+
+## Performance by Dataset Subsets
+
+### By Origin
+- **Synthetic**: Bach10Synth, MDBStemSynth, SpeechSynth, NSynth
+- **Real**: MIR1K, PTDB, PTDBNoisy, Vocadito
+
+| **Algorithm** | **Synthetic** | **Real** |
+|---|---|---|
+| HPA_RMVPE | 93.0% | 91.9% |
+| **HPA_RMVPE_76000** | **93.5%** | **92.4%** |
+| **RMVPE** | **93.5%** | 86.4% |
+
+### By Domain
+- **Speech**: PTDB, PTDBNoisy, SpeechSynth
+- **Music**: Bach10Synth, MDBStemSynth, NSynth, Vocadito, MIR1K
+
+| **Algorithm** | **Speech** | **Music** |
+|---|---|---|
+| HPA_RMVPE | 87.2% | 96.2% |
+| **HPA_RMVPE_76000** | **88.1%** | **96.5%** |
+| RMVPE | 81.0% | 95.8% |
+
+### By Cross-Dimension
+- **Synthetic + Speech**: SpeechSynth
+- **Synthetic + Music**: Bach10Synth, MDBStemSynth, NSynth
+- **Real + Speech**: PTDB, PTDBNoisy
+- **Real + Music**: Vocadito, MIR1K
+
+| **Algorithm** | **Synthetic + Speech** | **Synthetic + Music** | **Real + Speech** | **Real + Music** |
+|---|---|---|---|---|
+| HPA_RMVPE | 86.8% | 96.1% | 87.4% | 96.3% |
+| HPA_RMVPE_76000 | 87.6% | **96.5%** | **88.4%** | **96.5%** |
+| **RMVPE** | **90.5%** | 95.0% | 76.3% | **96.6%** |
+
+
+