Metadata-Version: 2.1
Name: asrbench-cli
Version: 0.1.0
Summary: A command-line tool for the ASRBench framework, simplifying audio transcription system benchmarking with a single config file, supporting popular and custom transcription systems
Author: ASRBench
Author-email: asrbenchmark@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Benchmark
Requires-Dist: asrbench (>=0.1.0,<0.2.0)
Requires-Dist: faster-whisper (>=1.0.3,<2.0.0)
Requires-Dist: librosa (>=0.10.2.post1,<0.11.0)
Requires-Dist: openai-whisper (==20240930)
Requires-Dist: transformers (>=4.44.2,<5.0.0)
Requires-Dist: typer[all] (>=0.13.1,<0.14.0)
Requires-Dist: vosk (>=0.3.45,<0.4.0)
Project-URL: Bug Tracker, https://github.com/ASRBench/asrbench-cli/issues
Project-URL: Documentation, https://asrbench.github.io/asrbench/cli/installation
Project-URL: Source, https://github.com/ASRBench/asrbench-cli
Description-Content-Type: text/markdown

[:brazil: Versão Português Brasileiro](./README-pt.md)

# Asrbench-Cli
[//]: # (![python]&#40;https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white&#41;)
[//]: # (![pypi package version]&#40;https://img.shields.io/pypi/pyversions/:asrbench-cli?style=for-the-badge&#41;)

## Introduction
ASRBench CLI is a complementary tool to the [ASRBench](https://github.com/ASRBench/asrbench) framework, designed 
to simplify the execution of audio transcription system benchmarks directly from the command line.

With it, you can:

- Use the most popular transcription systems on the market.
- Add new customized transcription systems.
- Run benchmarks simply, using just one configuration file.

## Installation
To install ASRBench, all you need is [Python 3.12+](https://www.python.org/downloads/) and pip. Use the
command below to install the latest version:

```sh
pip install asrbench-cli
```

> [!NOTE]
> The list of project dependencies is available in the file [pyproject.toml](https://github.com/ASRBench/asrbench-cli/blob/main/pyproject.toml)

## Usage
The CLI requires a configuration file to work, in the same format as the framework. 
benchmark environment, defining datasets, transcribers and output parameters in a simple and declarative way. 
declarative. For more details on the structure of the configuration file, go to
[documentation](https://asrbench.github.io/asrbench/cli/installation).

Below is an example of the configuration file structure:

```yaml
# data output configuration
output:
  type: "csv"
  dir: "./results"
  filename: "example_filename"

# datasets configuration
datasets:
  dataset1:
    audio_dir: "resources/common_voice_05/wav"
    reference_dir: "resources/common_voice_05/txt"

# transcription system configuration
transcribers:
  faster_whisper_medium_int8:
    asr: "faster_whisper"
    model: "medium"
    compute_type: "int8"
    device: "cpu"
    beam_size: 5
    language: "en"  
```

With the configuration file in hand, just run the command:

```sh
asrbench-cli run path/to/configfile.yml
```
The CLI will read the configuration file, set up the benchmark and run it automatically. All progress and steps 
will be displayed directly in the terminal, including the percentage of completion and a time estimate for the 
completion of each stage of the transcription process.

> [!TIP]
> For a complete list of available commands and instructions for more advanced uses, see [documentation](https://asrbench.github.io/asrbench/cli/usage).

## License
Distributed under the MIT license. See the [LICENSE](https://github.com/ASRBench/asrbench-cli/blob/main/LICENSE) file for more details.

