Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing Pypi Package Metadata #24

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![Rev Logo](resources/logo_purple.png#gh-light-mode-only)
![Rev Logo](resources/logo_white.png#gh-dark-mode-only)
![Rev Logo](https://github.com/revdotcom/reverb/blob/main/resources/logo_purple.png#gh-light-mode-only)
![Rev Logo](https://github.com/revdotcom/reverb/blob/main/rresources/logo_white.png#gh-dark-mode-only)
# Reverb
Open source inference and evaluation code for Rev's state-of-the-art speech recognition and diarization models. The speech recognition (ASR) code uses the [WeNet](https://github.com/wenet-e2e/wenet) framework and the speech diarization code uses the [Pyannote](https://github.com/pyannote/pyannote-audio) framework. More detailed model descriptions can be found in our [blog](https://www.rev.com/blog/speech-to-text-technology/introducing-reverb-open-source-asr-diarization) and the models can be downloaded from [huggingface](https://huggingface.co/Revai).

Expand Down Expand Up @@ -46,7 +46,12 @@ This codebase is compatible Python 3.10+. To get started, simply run
```bash
pip install .
```
This will install the `reverb` package into your python environment which is a modified version of the [wenet python package](https://github.com/wenet-e2e/wenet/tree/main?tab=readme-ov-file#install-python-package). In order to use `reverb`'s code, make sure you **do not** have another wenet installation in your environment which might cause conflict issues.
Alternatively, install the latest package on pypi.
```bash
pip install rev-reverb
```

This will install the reverb package into your python environment which is a modified version of the [wenet python package](https://github.com/wenet-e2e/wenet/tree/main?tab=readme-ov-file#install-python-package). In order to use reverb's code, make sure you **do not** have another wenet installation in your environment which might cause conflict issues.

> [!TIP]
> While we suggest using our CLI or Python package to download the reverb model, you can also download it manually by running:
Expand Down Expand Up @@ -98,7 +103,7 @@ reverb = wenet.load_model("reverb_asr_v1")
output = reverb.transcribe("audio.mp3", format="ctm")
print(output)
```
All arguments available to the `reverb` command line are also parameters that can be included in the `transcribe` command.
All arguments available to the reverb command line are also parameters that can be included in the `transcribe` command.
```python
import wenet
reverb = wenet.load_model("reverb_asr_v1")
Expand Down
8 changes: 6 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "rev-reverb"
version = "0.1.0"
version = "0.1.1"
dynamic = ["dependencies"]
requires-python = ">=3.10"
authors = [
Expand All @@ -13,7 +13,7 @@ authors = [
maintainers = [
{name = "Rev Speechteam", email = "[email protected]"},
]
description = "A simplified python packge to interact with the reverb models"
description = "A simplified python package to interact with the reverb models."
readme = "README.md"
license = {file = "LICENSE"}
keywords = ["asr", "reverb", "rev", "diarization"]
Expand All @@ -22,6 +22,10 @@ classifiers = [
"Programming Language :: Python :: 3.10"
]

[project.urls]
Huggingface = "https://huggingface.co/Revai"
GitHub = "https://github.com/revdotcom/reverb/tree/main"

[tool.setuptools.package-dir]
wenet = "asr/wenet"

Expand Down