OpenSTBench 0.2.0__py3-none-any.whl

openstbench-0.2.0.dist-info/METADATA

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: OpenSTBench
+Version: 0.2.0
+Summary: Open speech and translation benchmarking toolkit supporting MT, ASR, TTS, SimulST, VC, and paralinguistics with optimized CJK language support
+Author-email: Yanjie An <691476922@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sjtuayj/OpenSTBench
+Project-URL: Repository, https://github.com/sjtuayj/OpenSTBench
+Project-URL: Documentation, https://github.com/sjtuayj/OpenSTBench#readme
+Project-URL: Bug Tracker, https://github.com/sjtuayj/OpenSTBench/issues
+Keywords: translation,evaluation,BLEU,COMET,BLEURT,ASR,speech-synthesis,voice-conversion,UTMOS,WER,machine-translation,multilingual,CJK,emotion,paralinguistics,CLAP,audio-events
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: torch>=1.9.0
+Requires-Dist: torchaudio>=0.9.0
+Requires-Dist: numpy
+Requires-Dist: sacrebleu>=2.0.0
+Requires-Dist: pandas
+Requires-Dist: tqdm
+Requires-Dist: scipy
+Requires-Dist: soundfile
+Requires-Dist: textgrid
+Requires-Dist: transformers
+Requires-Dist: matplotlib
+Requires-Dist: resemblyzer
+Provides-Extra: comet
+Requires-Dist: unbabel-comet>=2.2.2; extra == "comet"
+Provides-Extra: whisper
+Requires-Dist: openai-whisper; extra == "whisper"
+Provides-Extra: speech-quality
+Requires-Dist: jiwer; extra == "speech-quality"
+Provides-Extra: emotion
+Requires-Dist: funasr; extra == "emotion"
+Requires-Dist: modelscope; extra == "emotion"
+Provides-Extra: paralinguistics
+Requires-Dist: transformers; extra == "paralinguistics"
+Provides-Extra: all
+Requires-Dist: unbabel-comet>=2.2.2; extra == "all"
+Requires-Dist: openai-whisper; extra == "all"
+Requires-Dist: jiwer; extra == "all"
+Requires-Dist: funasr; extra == "all"
+Requires-Dist: modelscope; extra == "all"
+Requires-Dist: transformers; extra == "all"
+
+# OpenSTBench
+
+English | [Chinese](./README_zh.md)
+
+[![PyPI version](https://badge.fury.io/py/OpenSTBench.svg)](https://pypi.org/project/OpenSTBench/)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+OpenSTBench is an evaluation toolkit centered on translation and speech translation. It provides a unified way to score text translation quality, speech output quality, preservation-related properties, and streaming latency.
+
+## What It Can Be Used For
+
+This project is best suited for these directions:
+
+- MT or S2TT text-side evaluation with `BLEU`, `chrF++`, `COMET`, and `BLEURT`
+- S2ST evaluation by combining text quality, speech quality, speaker similarity, and latency
+- Streaming or simultaneous speech translation latency evaluation with a custom agent
+- Preservation analysis for speech translation outputs, including speaker similarity, emotion, and paralinguistic similarity
+
+## Core Modules
+
+| Module | Main Use | Typical Metrics |
+| :--- | :--- | :--- |
+| `TranslationEvaluator` | Text-side translation quality | `sacreBLEU`, `chrF++`, `COMET`, `BLEURT` |
+| `SpeechQualityEvaluator` | Naturalness and text-speech consistency | `UTMOS`, `WER_Consistency`, `CER_Consistency` |
+| `SpeakerSimilarityEvaluator` | Speaker preservation | `wavlm_similarity`, `resemblyzer_similarity` |
+| `EmotionEvaluator` | Emotion preservation or classification accuracy | `Emotion2Vec_Cosine_Similarity`, `Audio_Emotion_Accuracy` |
+| `ParalinguisticEvaluator` | Non-verbal and paralinguistic preservation | `Paralinguistic_Fidelity_Cosine`, `Acoustic_Event_Preservation_Rate`, `Acoustic_Event_Preservation_Macro_F1`, `Acoustic_Event_Preservation_Macro_Recall`, `Event_Aligned_Preservation_Rate`, `Conditional_Relative_Onset_Error` |
+| `LatencyEvaluator` | Streaming / simultaneous translation latency | `StartOffset`, `ATD`, `CustomATD`, `RTF`, `Model_Generate_RTF` |
+
+## Installation
+
+Basic install:
+
+```bash
+pip install OpenSTBench
+```
+
+Optional extras:
+
+```bash
+pip install "OpenSTBench[comet]"
+pip install "OpenSTBench[whisper]"
+pip install "OpenSTBench[speech_quality]"
+pip install "OpenSTBench[emotion]"
+pip install "OpenSTBench[paralinguistics]"
+pip install "OpenSTBench[all]"
+```
+
+If you need BLEURT:
+
+```bash
+pip install git+https://github.com/lucadiliello/bleurt-pytorch.git
+```
+
+## Import
+
+PyPI package name:
+
+```python
+OpenSTBench
+```
+
+Python import name:
+
+```python
+openstbench
+```
+
+Example:
+
+```python
+from openstbench import TranslationEvaluator, SpeechQualityEvaluator
+```
+
+## Quick Start
+
+Quick-start scripts live under `examples/`.
+
+Python examples:
+
+- `examples/python/translation_eval.py`
+- `examples/python/speech_quality_eval.py`
+- `examples/python/speaker_similarity_eval.py`
+- `examples/python/emotion_eval.py`
+- `examples/python/paralinguistic_eval.py`
+- `examples/python/paralinguistic_identity_baseline.py`
+- `examples/python/latency_eval.py`
+
+Shell examples:
+
+- `examples/bash/install_extras.sh`
+- `examples/bash/run_latency_cli.sh`
+
+Latency output distinguishes two RTF variants:
+
+- `Real_Time_Factor_(RTF)`: system-level RTF. This includes agent policy overhead, pre/post-processing, and other runtime costs around model inference.
+- `Model_Generate_RTF`: model-level RTF. This is reported only when the agent explicitly records model inference time via `record_model_inference_time(...)` or returns it in `Segment.config["model_inference_time"]`.
+
+## Input Conventions
+
+Common text inputs support:
+
+- Python `List[str]`
+- `.txt` files with one sample per line
+- `.json` files
+
+Common audio inputs support:
+
+- folder path
+- Python `List[str]`
+- `.txt` files
+- `.json` files
+
+## Notes
+
+- For `zh` / `ja` / `ko`, the toolkit uses CJK-aware handling for text-side evaluation.
+- `SpeechQualityEvaluator` returns `CER_Consistency` for `zh` / `ja` / `ko`, and `WER_Consistency` for most other languages.
+- `ParalinguisticEvaluator` always supports `Paralinguistic_Fidelity_Cosine`, a continuous CLAP-based audio similarity score between source and target speech.
+- The discrete preservation branch is an utterance-level single-label task. With source-side gold labels, it reports `Acoustic_Event_Preservation_Rate`, `Acoustic_Event_Preservation_Macro_F1`, and `Acoustic_Event_Preservation_Macro_Recall`.
+- If `source_onsets_ms` are available, the evaluator can also report alignment-aware metrics: `Event_Aligned_Preservation_Rate` and `Conditional_Relative_Onset_Error`.
+- Alignment is computed on relative onset position, not absolute wall-clock time. This makes it suitable for cross-lingual S2ST where source and target utterance durations naturally differ.
+- If target-side onset timestamps are not provided, the default localizer estimates them with CLAP sliding-window scoring conditioned on the target event label.
+- These alignment metrics should be interpreted as weak, coarse-grained alignment signals rather than timestamp-accurate event localization benchmarks.
+- If source-side gold labels are not available, the evaluator can still run in prediction-only mode and reports `Predicted_Event_Consistency_Rate`, `Predicted_Event_Consistency_Macro_F1`, and `Predicted_Event_Consistency_Macro_Recall`.
+- The default discrete predictor is a closed-set CLAP classifier over `candidate_labels`. Users may replace it with any custom predictor object that implements `predict(audio_paths, candidate_labels)`.
+- The default event localizer is also replaceable. Custom localizers only need to implement `localize(audio_paths, labels, candidate_labels)`.
+- Dataset-specific label mapping is intentionally outside the core package. Pass `candidate_labels` and `label_normalizer` at call time so the same evaluator works across datasets without changing core code.
+- For offline environments, `clap_model_path` accepts either a Hugging Face repo id or a local model directory or snapshot.
+- In S2S latency evaluation, alignment prefers the model's native transcript when available. If the model is audio-only, the evaluator can optionally use ASR fallback to prepare alignment text.
+- For S2S forced alignment, pass language-appropriate MFA models through `alignment_acoustic_model` and `alignment_dictionary_model`. The defaults are English.
+- Some modules rely on optional dependencies or local model paths in offline environments.

openstbench-0.2.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+openstbench/__init__.py,sha256=Ghp94XhK7HHbl0lD-wTH8WVgUOea9Td0TpMlQ2kqq-0,4531
+openstbench/dataset.py,sha256=clWzabMDrWE0_IQwJCY0Dlzsu0uW3rCbHG7Gm3kuqZw,6178
+openstbench/emotion_evaluator.py,sha256=pIcnayhmaq_UGlTaGZ4FGHvjxFtjP4E1QTrXehWrpo0,11577
+openstbench/paralinguistic_evaluator.py,sha256=e70KGvynRoq5oWGmjy0y2C2WXAERJbxP0dF3ydxvcL8,53756
+openstbench/speaker_similarity_evaluator.py,sha256=PR085aCI4e4CkO14z1gDs5OPqRJ9Q806p8Q0zqTbbkg,6310
+openstbench/speech_quality_evaluator.py,sha256=ncyOMnnUaqginr_WY2B91p64M46bRpVKmTaEndACRXg,7109
+openstbench/translation_evaluator.py,sha256=Dgf_73AZh6wOBbJOEFPJbqJLP1OtIMeOdScTsuA4fPo,9740
+openstbench/latency/__init__.py,sha256=2AXvZVDzy7FMU7K3ZPBTGD8YwvW4xKv93qomlUsrgdA,219
+openstbench/latency/agent.py,sha256=L_L614GpJVP-SJ5ppi-BZdTp6Dyc9KInOAbt7DXp0vQ,3420
+openstbench/latency/basics.py,sha256=-LYlm3hu-CESA2MHtnlw3uSMWw6MiNhJMu6zgtbnCec,1730
+openstbench/latency/cli.py,sha256=pmv-VxVWr1lvAx4UMMRGwS3cE-MYMjEx6sUHXIwfJ94,11104
+openstbench/latency/instance.py,sha256=iimE6UxNtPqoLKXscb-56604Ao_axuTPFKWZLvO8BIY,7171
+openstbench/latency/metrics.py,sha256=lEl7Ull7enGEAxOoeKbvTIJ32kHjdAW9KzLYIvK_RZI,16498
+openstbench/latency/utils.py,sha256=AWKgRagXjvZZ0Dc7RyinY4lH-whCs0YUdys9m3qB4NQ,9324
+openstbench-0.2.0.dist-info/METADATA,sha256=uaJCE1ZnL51atSCRHqSKJqBGzKKCydeku8h0pkW_Tcg,8469
+openstbench-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+openstbench-0.2.0.dist-info/top_level.txt,sha256=ze2cgr1EJqh_5WKmpXXSrEMZZbPvJ-u-hwtrwXeJ-d0,12
+openstbench-0.2.0.dist-info/RECORD,,

openstbench-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

openstbench-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+openstbench