Files
scribe/autotranscript/autotranscript.py
T
2023-07-10 13:37:37 +02:00

280 lines
11 KiB
Python

from .audio import AudioProcessor
from .diarisation import Diariser
from .transcriber import Transcriber, whisper
from .transcript_exporter import Transcript
from typing import Union , TypeVar
from tqdm import trange
import torch
import os
from glob import iglob
from subprocess import run
from warnings import warn
import argparse
from numpy import ndarray
diarisation = TypeVar('diarisation')
class AutoTranscribe:
def __init__(self,
whisper_model: Union[bool, str, whisper] = None,
dia_model : Union[bool, str, diarisation] = None,
**kwargs) -> None:
"""
AutoTranscribe class
This class is the core Api Class of the autotranscript package.
It allows to transcribe audio files with a whisper model and
pyannote diarization model.
Therefore it is do a fully automatic transcription of audio files.
:param whisper_model: path to whisper model or whisper model
:param dia_model: path to pyannote diarization model
:param dia_kwargs: kwargs for pyannote diarization model
:param whisper_kwargs: kwargs for whisper model
"""
if whisper_model is None:
self.transcriber = Transcriber.load_model("medium")
elif isinstance(whisper_model, str):
self.transcriber = Transcriber.load_model(whisper_model, **kwargs)
else:
self.transcriber = whisper_model
if dia_model is None:
self.diariser = Diariser.load_model()
elif isinstance(dia_model, str):
self.diariser = Diariser.load_model(dia_model, **kwargs)
else:
self.diariser = dia_model
print("AutoTranscribe initialized all models successfully loaded.")
def transcribe(self, audiofile : Union[str, torch.Tensor, ndarray],
remove_original : bool = False,
*args, **kwargs) -> Transcript:
"""
Transcribe audiofile with whisper model and pyannote diarization model
:param audiofile: path to audiofile or torch.Tensor
:param remove_original: if True the original audiofile will be removed after
transcription.
:return: Transcript object which contains the transcript and can be used to
export the transcript to differnt formats.
"""
audiofile = self.get_audiofile(audiofile)
final_transcript = dict()
dia_audio = {"waveform" :
audiofile.waveform.reshape(1,len(audiofile.waveform)),
"sample_rate": audiofile.sr}
print("Starting diarisation.")
diarisation = self.diariser.diarization(dia_audio,
*args , **kwargs)
print("Diarisation finished. Starting transcription.")
audiofile.sr = torch.Tensor([audiofile.sr]).to(audiofile.waveform.device)
for i in trange(len(diarisation["segments"]), desc= "Transcribing"):
seg = diarisation["segments"][i]
audio = audiofile.cut(seg[0], seg[1])
transcript = self.transcriber.transcribe(audio, *args , **kwargs)
final_transcript[i] = {"speaker" : diarisation["speakers"][i],
"segment" : seg,
"text" : transcript}
if remove_original:
if kwargs.get("shred") is True:
self.remove_audio_file(audiofile, shred=True)
else:
self.remove_audio_file(audiofile, shred=False)
return Transcript(final_transcript)
@staticmethod
def remove_audio_file(audiofile : str,
shred : bool = False) -> None:
"""
removes orginal audiofile to avoid disk space problems
or to enshure data privacy
:param audiofile: path to audiofile
:param shred: if True audiofile will be shredded and not only removed
"""
if not os.path.exists(audiofile):
raise ValueError(f"Audiofile {audiofile} does not exist.")
if shred:
warn("Shredding audiofile can take a long time.", RuntimeWarning)
gen = iglob(f'{audiofile}', recursive=True)
cmd = ['shred', '-zvu', '-n', '10', f'{audiofile}']
if os.path.isdir(audiofile):
raise ValueError(f"Audiofile {audiofile} is a directory.")
for file in gen:
print(f'shredding {file} now\n')
run(cmd , check=True)
else:
os.remove(audiofile)
print(f"Audiofile {audiofile} removed.")
@staticmethod
def get_audiofile(audiofile : Union[str, torch.Tensor, ndarray],
*args, **kwargs) -> AudioProcessor:
"""
Get audiofile as TorchAudioProcessor
:param audiofile: path to audiofile or torch.Tensor
:type audiofile: Union[str, torch.Tensor]
:return: object of audiofile containes
waveform and sample_rate in torch.Tensor format.
:rtype: TorchAudioProcessor
"""
if isinstance(audiofile, str):
audiofile = AudioProcessor.from_file(audiofile)
elif isinstance(audiofile, torch.Tensor):
audiofile = AudioProcessor(audiofile[0], audiofile[1])
elif isinstance(audiofile, ndarray):
audiofile = AudioProcessor(torch.Tensor(audiofile[0]),
audiofile[1])
if not isinstance(audiofile, AudioProcessor):
raise ValueError(f'Audiofile must be of type AudioProcessor,' \
f'not {type(audiofile)}')
return audiofile
def cli():
from whisper import available_models
from whisper.utils import get_writer
from whisper.tokenizer import LANGUAGES , TO_LANGUAGE_CODE
from .transcriber import WHISPER_DEFAULT_PATH
from .diarisation import PYANNOTE_DEFAULT_PATH
def str2bool(string):
str2val = {"True": True, "False": False}
if string in str2val:
return str2val[string]
else:
raise ValueError(f"Expected one of {set(str2val.keys())}, got {string}")
# fmt: off
parser = argparse.ArgumentParser(formatter_class=
argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument("audio", nargs="+", type=str,
help="audio file(s) to transcribe")
parser.add_argument("--wmodel", default="medium",
help="name of the Whisper model to use")
parser.add_argument("--wmodel_dir", type=str, default= WHISPER_DEFAULT_PATH,
help="the path to save model files; uses ./models/whisper by default")
parser.add_argument("--dia_dir", type=str, default = PYANNOTE_DEFAULT_PATH)
parser.add_argument("--htoken", default="", type=str, help="HuggingFace token for private model download")
parser.add_argument("--local", type=str2bool, default=False,
help="whether to allow model download if model is not found locally")
parser.add_argument("--device",
default="cuda" if torch.cuda.is_available() else "cpu",
help="device to use for PyTorch inference")
parser.add_argument("--threads", type=int, default=0,
help="number of threads used by torch for CPU inference; supercedes MKL_NUM_THREADS/OMP_NUM_THREADS")
parser.add_argument("--output_dir", "-o", type=str, default=".",
help="directory to save the outputs")
parser.add_argument("--output_format", "-f", type=str, default="txt",
choices=["txt", "json", "md", "html"],
help="format of the output file; if not specified, all available formats will be produced")
parser.add_argument("--verbose", type=str2bool, default=True,
help="whether to print out the progress and debug messages")
parser.add_argument("--task", type=str, default="transcribe",
choices=["transcribe", "diarize","wtranscribe"],
help="whether to perfrom transcription and diazation or only one of them")
parser.add_argument("--language", type=str, default=None,
choices=sorted(LANGUAGES.keys()) + sorted([k.title() for k in TO_LANGUAGE_CODE.keys()]),
help="language spoken in the audio, specify None to perform language detection")
# fmt: on
args = parser.parse_args().__dict__
model_name: str = args.pop("wmodel")
model_dir: str = args.pop("wmodel_dir")
output_dir: str = args.pop("output_dir")
output_format: str = args.pop("output_format")
local :str = args.pop("local")
task = args.pop("task")
device: str = args.pop("device")
os.makedirs(output_dir, exist_ok=True)
if (threads := args.pop("threads")) > 0:
torch.set_num_threads(threads)
wkwargs = {"download_root": model_dir,
"local": local,
"device": device}
diarisation_kwargs = {"local": local,
"token" : args.pop("htoken")}
model = AutoTranscribe(whisper_model= model_name,
whisper_kwargs= wkwargs,
dia_model= args.pop("dia_dir"),
dia_kwargs= diarisation_kwargs,)
if task == "transcribe":
for audio in args.pop("audio"):
out = model.transcribe(audio, language = args.pop("language"))
basename = audio.split("/")[-1].split(".")[0]
spath = f"{output_dir}/{basename}.{output_format}"
out.save(spath)
elif task == "diarize":
warn("Diarization is still in beta and may not work as expected.",
RuntimeWarning)
for audio in args.pop("audio"):
out = model.diariser.diarization(audio)
basename = audio.split("/")[-1].split(".")[0]
spath = f"{output_dir}/{basename}.json"
print(f"diairization results saved to {spath}")
out.save(spath)
elif task == "wtranscribe":
writer = get_writer(output_format, output_dir)
warn("whisper transcription is poorly supported and may not work as expected." \
"It is recommendet to use the whisper cli directly",
RuntimeWarning)
for audio in args.pop("audio"):
out = model.transcriber.transcribe(audio, language = args.pop("language"))
basename = audio.split("/")[-1].split(".")[0]
writer(out, audio)
if __name__ == "__main__":
cli()