feat(cli): add --revision option to most pyannote.audio commands (#1958)

This commit is contained in:
Hervé BREDIN authored and GitHub committed 2025-12-04 09:35:52 +01:00
1 parent 222c5b59ce
commit 2941364af6
2 files changed
+72 -45

No files matched your search

+1
View File
@@ -2,6 +2,7 @@
## next
- feat(cli): add `--revision` option to most CLI commands
- feat(util): add `Calibration.safe_transform` method (supports NaNs as well as any shape)
- fix(model): fix `Model.from_pretrained` to support `lightning` 2.6+
+71 -45
View File
@@ -40,7 +40,7 @@ import pyannote.database
import torch
import typer
import yaml
from pyannote.audio import Audio, Pipeline, Model
from pyannote.audio import Audio, Model, Pipeline
from pyannote.core import Annotation
from pyannote.metrics.base import BaseMetric
from pyannote.metrics.diarization import DiarizationErrorRate, JaccardErrorRate
@@ -285,16 +285,20 @@ def download(
help="Pretrained pipeline (e.g. pyannote/speaker-diarization-community-1)"
),
],
token: Annotated[
str,
typer.Argument(
help="Huggingface token to be used for downloading from Huggingface hub."
),
],
cache: Annotated[
Path,
revision: Annotated[
Optional[str],
typer.Option(
help="Path to the folder where files downloaded from Huggingface hub are stored.",
help="Pretrained pipeline revision.",
),
] = None,
token: Annotated[
Optional[str],
typer.Argument(help="Huggingface token."),
] = None,
cache: Annotated[
Optional[Path],
typer.Option(
help="Path to the folder where files downloaded from Huggingface are stored.",
exists=True,
dir_okay=True,
file_okay=False,
@@ -309,7 +313,7 @@ def download(
# load pretrained pipeline
pretrained_pipeline = Pipeline.from_pretrained(
pipeline, token=token, cache_dir=cache
pipeline, revision=revision, token=token, cache_dir=cache
)
if pretrained_pipeline is None:
print(f"Could not load pretrained pipeline from {pipeline}.")
@@ -335,7 +339,7 @@ def apply(
),
],
into: Annotated[
Path,
Optional[Path],
typer.Option(
help="Path to file or directory where results are saved.",
exists=False,
@@ -345,13 +349,20 @@ def apply(
resolve_path=True,
),
] = None,
device: Annotated[
Device, typer.Option(help="Accelerator to use (CPU, CUDA, MPS)")
] = Device.AUTO,
cache: Annotated[
Path,
revision: Annotated[
Optional[str],
typer.Option(
help="Path to the folder where files downloaded from Huggingface hub are stored.",
help="Pretrained pipeline revision.",
),
] = None,
token: Annotated[
Optional[str],
typer.Argument(help="Huggingface token."),
] = None,
cache: Annotated[
Optional[Path],
typer.Option(
help="Path to the folder where files downloaded from Huggingface are stored.",
exists=True,
dir_okay=True,
file_okay=False,
@@ -359,13 +370,18 @@ def apply(
resolve_path=True,
),
] = None,
device: Annotated[
Device, typer.Option(help="Accelerator to use (CPU, CUDA, MPS)")
] = Device.AUTO,
):
"""
Apply a pretrained PIPELINE to an AUDIO file or directory
"""
# load pretrained pipeline
pretrained_pipeline = Pipeline.from_pretrained(pipeline, cache_dir=cache)
pretrained_pipeline = Pipeline.from_pretrained(
pipeline, revision=revision, token=token, cache_dir=cache
)
if pretrained_pipeline is None:
print(f"Could not load pretrained pipeline from {pipeline}.")
raise typer.exit(code=1)
@@ -375,7 +391,6 @@ def apply(
pretrained_pipeline.to(torch_device)
if audio.is_dir():
if into is None or not into.is_dir():
typer.echo("When AUDIO is a directory, INTO must also be a directory.")
raise typer.exit(code=1)
@@ -385,7 +400,6 @@ def apply(
jsons: list[Path | None] = [into / (path.stem + ".json") for path in inputs]
else:
if not (into is None or into.is_file()):
typer.echo("When AUDIO is a file, INTO must also be a file.")
raise typer.exit(code=1)
@@ -395,7 +409,6 @@ def apply(
jsons: list[Path | None] = [into.with_suffix(".json") if into else None]
for current_input, current_rttm, current_json in zip(inputs, rttms, jsons):
prediction = pretrained_pipeline(current_input)
speaker_diarization = get_diarization(prediction)
@@ -522,6 +535,27 @@ def benchmark(
case_sensitive=False,
),
] = Subset.test,
revision: Annotated[
Optional[str],
typer.Option(
help="Pretrained pipeline revision.",
),
] = None,
token: Annotated[
Optional[str],
typer.Argument(help="Huggingface token."),
] = None,
cache: Annotated[
Optional[Path],
typer.Option(
help="Path to the folder where files downloaded from Huggingface are stored.",
exists=True,
dir_okay=True,
file_okay=False,
writable=True,
resolve_path=True,
),
] = None,
device: Annotated[
Device, typer.Option(help="Accelerator to use (CPU, CUDA, MPS)")
] = Device.AUTO,
@@ -538,17 +572,6 @@ def benchmark(
num_speakers: Annotated[
NumSpeakers, typer.Option(help="Number of speakers (oracle or auto)")
] = NumSpeakers.AUTO,
cache: Annotated[
Path,
typer.Option(
help="Path to the folder where files downloaded from Huggingface hub are stored.",
exists=True,
dir_okay=True,
file_okay=False,
writable=True,
resolve_path=True,
),
] = None,
optimize: Annotated[
bool,
typer.Option(
@@ -562,10 +585,7 @@ def benchmark(
),
] = False,
per_file: Annotated[
bool,
typer.Option(
help="Save one RTTM/JSON file per processed audio file."
)
bool, typer.Option(help="Save one RTTM/JSON file per processed audio file.")
] = False,
):
"""
@@ -578,7 +598,9 @@ def benchmark(
"""
# load pretrained pipeline
pretrained_pipeline = Pipeline.from_pretrained(pipeline, cache_dir=cache)
pretrained_pipeline = Pipeline.from_pretrained(
pipeline, revision=revision, token=token, cache_dir=cache,
)
if pretrained_pipeline is None:
print(f"Could not load pretrained pipeline from {pipeline}.")
raise typer.exit(code=1)
@@ -808,7 +830,9 @@ def benchmark(
yaml.dump({"min_duration_off": best_min_duration_off}, yml)
if not per_file:
optimized_rttm_file = into / f"{benchmark_name}.OptimizedMinDurationOff.rttm"
optimized_rttm_file = (
into / f"{benchmark_name}.OptimizedMinDurationOff.rttm"
)
# make sure we don't overwrite previous results
if optimized_rttm_file.exists():
@@ -816,7 +840,9 @@ def benchmark(
for file in files:
if per_file:
optimized_rttm_file = rttm_dir / f"{file['uri']}.OptimizedMinDurationOff.rttm"
optimized_rttm_file = (
rttm_dir / f"{file['uri']}.OptimizedMinDurationOff.rttm"
)
with open(optimized_rttm_file, "w" if per_file else "a") as rttm:
file["best_speaker_diarization"].write_rttm(rttm)
@@ -851,11 +877,11 @@ def strip(
"""
keys = [
"pytorch-lightning_version", # * pytorch-lightning needs
"hparams_name", # those values to initialize
"hyper_parameters", # the model architecture
"state_dict", # * actual weights
"pyannote.audio", # * pyannote.audio dependencies
"pytorch-lightning_version", # * pytorch-lightning needs
"hparams_name", # those values to initialize
"hyper_parameters", # the model architecture
"state_dict", # * actual weights
"pyannote.audio", # * pyannote.audio dependencies
]
old_checkpoint = torch.load(