doc: rename 4.0 to community-1

This commit is contained in:
Hervé BREDIN committed 2025-09-13 23:33:52 +02:00
1 parent ab57f087c4
commit 341955bd7b
3 files changed
+14 -14

No files matched your search

+7 -7
View File
@@ -6,17 +6,17 @@
#### Improved speaker assignment and counting
`pyannote/speaker-diarization-4.0` pretrained pipeline relies on VBx clustering instead of agglomerative hierarchical clustering (as suggested by [BUT Speech@FIT](https://speech.fit.vut.cz/) researchers [Petr Pálka](https://github.com/Selesnyan) and [Jiangyu Han](https://github.com/jyhan03)).
`pyannote/speaker-diarization-community-1` pretrained pipeline relies on VBx clustering instead of agglomerative hierarchical clustering (as suggested by [BUT Speech@FIT](https://speech.fit.vut.cz/) researchers [Petr Pálka](https://github.com/Selesnyan) and [Jiangyu Han](https://github.com/jyhan03)).
#### *Exclusive* speaker diarization
`pyannote/speaker-diarization-4.0` pretrained pipeline returns a new *exclusive* speaker diarization, on top of the regular speaker diarization.
`pyannote/speaker-diarization-community-1` pretrained pipeline returns a new *exclusive* speaker diarization, on top of the regular speaker diarization.
This is a feature which is [backported from our latest commercial model](https://www.pyannote.ai/blog/precision-2) that simplifies the reconciliation between fine-grained speaker diarization timestamps and (sometimes not so precise) transcription timestamps.
```python
from pyannote.audio import Pipeline
pipeline = Pipeline.from_pretrained(
"pyannote/speaker-diarization-4.0", token="huggingface-access-token")
"pyannote/speaker-diarization-community-1", token="huggingface-access-token")
output = pipeline("/path/to/conversation.wav")
print(output.speaker_diarization) # regular speaker diarization
print(output.exclusive_speaker_diarization) # exclusive speaker diarization
@@ -34,7 +34,7 @@ Change one line of code to use [pyannoteAI](https://docs.pyannote.ai) premium mo
```diff
from pyannote.audio import Pipeline
pipeline = Pipeline.from_pretrained(
- "pyannote/speaker-diarization-4.0", token="huggingface-access-token")
- "pyannote/speaker-diarization-community-1", token="huggingface-access-token")
+ "pyannote/speaker-diarization-precision-2, token="pyannoteAI-api-key")
diarization = pipeline("/path/to/conversation.wav")
```
@@ -43,12 +43,12 @@ diarization = pipeline("/path/to/conversation.wav")
Pipelines can now be stored alongside their internal models in the same repository, streamlining fully offline use.
1. Accept `pyannote/speaker-diarization-4.0` pipeline [user agreement](https://hf.co/pyannote/speaker-diarization-4.0)
1. Accept `pyannote/speaker-diarization-community-1` pipeline [user agreement](https://hf.co/pyannote/speaker-diarization-community-1)
2. Clone the pipeline repository from Huggingface (if prompted for a password, use a Huggingface access token with correct permissions)
```bash
$ git lfs install
$ git clone https://hf.co/pyannote/speaker-diarization-4.0 /path/to/directory/pyannote-speaker-diarization-4.0
$ git clone https://hf.co/pyannote/speaker-diarization-community-1 /path/to/directory/pyannote-speaker-diarization-community-1
```
3. Enjoy!
@@ -56,7 +56,7 @@ Pipelines can now be stored alongside their internal models in the same reposito
```python
# load pipeline from disk (works without internet connection)
from pyannote.audio import Pipeline
pipeline = Pipeline.from_pretrained('/path/to/directory/pyannote-speaker-diarization-4.0')
pipeline = Pipeline.from_pretrained('/path/to/directory/pyannote-speaker-diarization-community-1')
# run the pipeline locally on your computer
diarization = pipeline("audio.wav")
+4 -4
View File
@@ -21,7 +21,7 @@ Consider switching to [<img src="https://avatars.githubusercontent.com/u/1626986
1. Make sure [`ffmpeg`](https://ffmpeg.org/) is installed on your machine (needed by [`torchcodec`](https://docs.pytorch.org/torchcodec/) audio decoding library)
2. Install with [`uv`](https://docs.astral.sh/uv/)`add pyannote.audio` (recommended) or `pip install pyannote.audio`
3. Accept [`pyannote/speaker-diarization-4.0`](https://hf.co/pyannote/speaker-diarization-4.0) user conditions
3. Accept [`pyannote/speaker-diarization-community-1`](https://hf.co/pyannote/speaker-diarization-community-1) user conditions
4. Create Huggingface access token at [`hf.co/settings/tokens`](https://hf.co/settings/tokens)
```python
@@ -31,7 +31,7 @@ from pyannote.audio.pipelines.utils.hook import ProgressHook
# Open-source pyannote speaker diarization pipeline
pipeline = Pipeline.from_pretrained(
"pyannote/speaker-diarization-4.0",
"pyannote/speaker-diarization-community-1",
token="HUGGINGFACE_ACCESS_TOKEN")
# send pipeline to GPU (when available)
@@ -77,12 +77,12 @@ for turn, _, speaker in diarization.itertracks(yield_label=True):
Visit [`docs.pyannote.ai`](https://docs.pyannote.ai) to learn about other pyannoteAI features (voiceprinting, confidence scores, ...)
## Benchmark
Out of the box, <img src="https://avatars.githubusercontent.com/u/7559051" width="20" style="vertical-align:text-bottom;" /> `pyannote.audio` speaker diarization [pipeline v4.0](https://hf.co/pyannote/speaker-diarization-4.0) is expected to be much better than v3.1.
Out of the box, <img src="https://avatars.githubusercontent.com/u/7559051" width="20" style="vertical-align:text-bottom;" /> `pyannote.audio` speaker diarization [pipeline v4.0](https://hf.co/pyannote/speaker-diarization-community-1) is expected to be much better than v3.1.
<img src="https://avatars.githubusercontent.com/u/162698670" width="20" style="vertical-align:text-bottom;" /> `pyannoteAI` premium models are even better (and also 2x faster). <img src="https://avatars.githubusercontent.com/u/162698670" width="20" style="vertical-align:text-bottom;" /> `labs` model is currently in private beta.
| Benchmark (last updated in 2025-08) | <a href="https://hf.co/pyannote/speaker-diarization-3.1"><img src="https://avatars.githubusercontent.com/u/7559051" width="32" /><br/>v3.1</a> | <a href="https://hf.co/pyannote/speaker-diarization-4.0"><img src="https://avatars.githubusercontent.com/u/7559051" width="32" /><br/> v4.0</a> | <a href="https://docs.pyannote.ai"><img src="https://avatars.githubusercontent.com/u/162698670" width="32" /><br/>API</a> | <a href="https://docs.pyannote.ai"><img src="https://avatars.githubusercontent.com/u/162698670" width="32" /><br/>labs</a> |
| Benchmark (last updated in 2025-08) | <a href="https://hf.co/pyannote/speaker-diarization-3.1"><img src="https://avatars.githubusercontent.com/u/7559051" width="32" /><br/>v3.1</a> | <a href="https://hf.co/pyannote/speaker-diarization-community-1"><img src="https://avatars.githubusercontent.com/u/7559051" width="32" /><br/> v4.0</a> | <a href="https://docs.pyannote.ai"><img src="https://avatars.githubusercontent.com/u/162698670" width="32" /><br/>API</a> | <a href="https://docs.pyannote.ai"><img src="https://avatars.githubusercontent.com/u/162698670" width="32" /><br/>labs</a> |
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------------------------------------------------| ------------------------------------------------ | --- |
| [AISHELL-4](https://arxiv.org/abs/2104.03603) | 12.2 | 11.7 | 11.8 | 11.4 |
| [AliMeeting](https://www.openslr.org/119/) (channel 1) | 24.5 | 20.3 | 16.3 | 15.2 |
@@ -194,17 +194,17 @@ class SpeakerDiarization(SpeakerDiarizationMixin, Pipeline):
self,
legacy: bool = False,
segmentation: PipelineModel = {
"checkpoint": "pyannote/speaker-diarization-4.0",
"checkpoint": "pyannote/speaker-diarization-community-1",
"subfolder": "segmentation",
},
segmentation_step: float = 0.1,
embedding: PipelineModel = {
"checkpoint": "pyannote/speaker-diarization-4.0",
"checkpoint": "pyannote/speaker-diarization-community-1",
"subfolder": "embedding",
},
embedding_exclude_overlap: bool = False,
plda: PipelinePLDA = {
"checkpoint": "pyannote/speaker-diarization-4.0",
"checkpoint": "pyannote/speaker-diarization-community-1",
"subfolder": "plda",
},
clustering: str = "VBxClustering",