File size: 14,718 Bytes
7ddea44 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 |
# Copyright (c) Meta Platforms, Inc. and affiliates
# All rights reserved.
#
# This source code is licensed under the license found in the
# MIT_LICENSE file in the root directory of this source tree.
import argparse
import contextlib
import itertools
import logging
import subprocess
from argparse import Namespace
from dataclasses import dataclass
from pathlib import Path
from typing import Any, Dict, List, Optional, Tuple
import torch
import torchaudio
from fairseq2.data import Collater, DataPipeline, FileMapper
from fairseq2.data.audio import AudioDecoder, WaveformToFbankConverter
from fairseq2.data.text import StrSplitter, TextTokenizer, read_text
from fairseq2.data.typing import StringLike
from fairseq2.typing import DataType, Device
from torch import Tensor
from tqdm import tqdm
from seamless_communication.cli.eval_utils import (
compute_quality_metrics,
)
from seamless_communication.cli.m4t.predict import (
add_inference_arguments,
set_generation_opts,
)
from seamless_communication.inference import (
BatchedSpeechOutput,
Modality,
SequenceGeneratorOptions,
Translator,
)
from seamless_communication.models.unity import load_unity_text_tokenizer
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s %(levelname)s -- %(name)s: %(message)s",
)
logger = logging.getLogger(__name__)
@dataclass
class EvalContext:
task: str
"""String representing the task. Valid choices are
"S2ST", "S2TT", "T2ST", "T2TT", "ASR"."""
input_modality: Modality
"""The input modality of the task."""
output_modality: Modality
"""The output modality of the task."""
model_name: str
"""The name of the S2T UnitY model."""
data_file: Path
"""The pathname of the test TSV data file."""
audio_root_dir: Optional[Path]
"""The pathname of the directory under which
audio files are stored."""
target_lang: str
"""The target translation language."""
source_lang: Optional[str]
"""The source language."""
batch_size: int
"""The batch size for model input."""
device: Device
"""The device on which to run inference."""
dtype: DataType
"""The data type with which to run inference."""
output_path: Path
"""The pathname of the output directory to save
the evaluation results."""
ref_field: str
"""The reference target text field to compute
the BLEU score against."""
text_generation_opts: SequenceGeneratorOptions
"""Text generation hyperparameters."""
unit_generation_opts: Optional[SequenceGeneratorOptions]
"""Unit generation hyperparameters, not applicable
for the NAR T2U decoder."""
unit_generation_ngram_filtering: bool
"""If True, removes consecutive repeating ngrams
from the decoded unit output."""
def count_lines(filename: Path) -> int:
result = subprocess.run(["wc", "-l", filename], stdout=subprocess.PIPE)
return int(result.stdout.decode().split()[0])
def build_data_pipeline(
ctx: EvalContext,
text_tokenizer: TextTokenizer,
) -> DataPipeline:
with open(ctx.data_file, "r") as f:
header = f.readline().strip("\n").split("\t")
first_example = f.readline().strip("\n").split("\t")
# TODO: This will be soon auto-tuned. Right now hand-tuned for devfair.
n_parallel = 4
split_tsv = StrSplitter(names=header)
pipeline_builder = read_text(ctx.data_file, rtrim=True).skip(1).map(split_tsv)
if ctx.input_modality == Modality.SPEECH:
assert ctx.audio_root_dir is not None
map_file = FileMapper(root_dir=ctx.audio_root_dir, cached_fd_count=10)
pipeline_builder.map(map_file, selector="audio", num_parallel_calls=n_parallel)
decode_audio = AudioDecoder(dtype=torch.float32, device=ctx.device)
convert_to_fbank = WaveformToFbankConverter(
num_mel_bins=80,
waveform_scale=2**15,
channel_last=True,
standardize=True,
device=ctx.device,
dtype=ctx.dtype,
)
pipeline_builder.map(
[decode_audio, convert_to_fbank],
selector="audio.data",
num_parallel_calls=n_parallel,
)
else:
if "src_lang" in header:
source_lang = first_example[header.index("src_lang")]
ctx.source_lang = source_lang
elif ctx.source_lang is None:
raise ValueError(
(
"'src_lang' is missing in the data_file"
"header and in the arguments."
)
)
token_encoder = text_tokenizer.create_encoder(
task="translation", lang=source_lang, mode="source", device=ctx.device
)
pipeline_builder.map(
[token_encoder],
selector="src_text",
num_parallel_calls=n_parallel,
)
pipeline_builder.bucket(bucket_size=ctx.batch_size)
collate = Collater(pad_value=0, pad_to_multiple=1)
pipeline_builder.map(collate, num_parallel_calls=n_parallel)
pipeline_builder.prefetch(4)
return pipeline_builder.and_return()
def adjust_output_for_corrupted_inputs(
valid_sequences: Tensor,
text_output: List[StringLike],
speech_output: Optional[BatchedSpeechOutput],
) -> Tuple[List[StringLike], Optional[BatchedSpeechOutput]]:
adjusted_text_output: List[StringLike] = []
adjusted_speech_output: Optional[BatchedSpeechOutput] = None
if speech_output is not None:
assert (
len(text_output)
== len(speech_output.units)
== len(speech_output.audio_wavs)
)
adjusted_speech_output = BatchedSpeechOutput(units=[], audio_wavs=[])
batch_counter = 0
for is_valid in valid_sequences:
if is_valid:
adjusted_text_output.append(text_output[batch_counter])
if speech_output is not None:
assert adjusted_speech_output is not None
adjusted_speech_output.units.append(speech_output.units[batch_counter])
adjusted_speech_output.audio_wavs.append(
speech_output.audio_wavs[batch_counter]
)
batch_counter += 1
else:
# For the corrupted inputs, we save the following dummy outputs:
# empty string for text, empty list for units, 1 second of silence for audio.
adjusted_text_output.append("")
if adjusted_speech_output is not None:
sample_rate = adjusted_speech_output.sample_rate
adjusted_speech_output.units.append([])
adjusted_speech_output.audio_wavs.append(
torch.zeros(sample_rate).unsqueeze(0).unsqueeze(0)
)
return (
adjusted_text_output,
adjusted_speech_output,
)
def run_eval(
translator: Translator,
text_tokenizer: TextTokenizer,
ctx: EvalContext,
whisper_model_name: str,
) -> None:
pipeline = build_data_pipeline(ctx, text_tokenizer)
total_steps = count_lines(ctx.data_file) - 1
progress_bar = tqdm(total=total_steps)
output_path = ctx.output_path / ctx.data_file.stem
output_path.mkdir(parents=True, exist_ok=True)
if ctx.output_modality == Modality.SPEECH:
waveforms_dir = output_path / f"waveform_{ctx.data_file.stem}"
waveforms_dir.mkdir(parents=True, exist_ok=True)
model_outputs_tsv = output_path / f"model-outputs-{ctx.data_file.stem}.txt"
unit_outputs_tsv = output_path / f"unit_output-{ctx.data_file.stem}.txt"
with open(model_outputs_tsv, "w") as hyp_file, open(
unit_outputs_tsv, "w"
) if ctx.output_modality == Modality.SPEECH else contextlib.nullcontext(
itertools.repeat(None)
) as unit_file:
sample_id = 0
if ctx.output_modality == Modality.SPEECH:
hyp_file.write("ref_tgt_text\tpred_tgt_text\tpred_tgt_audio\n")
else:
hyp_file.write("ref_tgt_text\tpred_tgt_text\n")
for example in pipeline:
valid_sequences: Optional[Tensor] = None
if ctx.input_modality == Modality.SPEECH:
src = example["audio"]["data"]["fbank"]
# Skip corrupted audio tensors.
valid_sequences = ~torch.any(
torch.any(torch.isnan(src["seqs"]), dim=1), dim=1
)
if not valid_sequences.all():
logger.warning(
f"Sample IDs {sample_id} to {sample_id + ctx.batch_size} has some corrupted input."
)
src["seqs"] = src["seqs"][valid_sequences]
src["seq_lens"] = src["seq_lens"][valid_sequences]
else:
src = example["src_text"]
# Skip performing inference when the input is entirely corrupted.
if src["seqs"].numel() > 0:
(text_output, speech_output,) = translator.predict(
src,
ctx.task,
ctx.target_lang,
src_lang=ctx.source_lang,
text_generation_opts=ctx.text_generation_opts,
unit_generation_opts=ctx.unit_generation_opts,
unit_generation_ngram_filtering=ctx.unit_generation_ngram_filtering,
)
else:
text_output = []
if ctx.output_modality == Modality.SPEECH:
speech_output = BatchedSpeechOutput(units=[], audio_wavs=[])
else:
speech_output = None
if valid_sequences is not None and not valid_sequences.all():
(text_output, speech_output,) = adjust_output_for_corrupted_inputs(
valid_sequences,
text_output,
speech_output,
)
hyps = [str(s) for s in text_output]
refs = [str(s) for s in example[ctx.ref_field]]
for i in range(len(text_output)):
if ctx.output_modality == Modality.SPEECH:
assert speech_output is not None
u = speech_output.units[i]
str_units = [str(i) for i in u]
unit_file.write(" ".join(str_units) + "\n")
wav_fp = str(waveforms_dir / f"{sample_id}_pred.wav")
torchaudio.save(
wav_fp,
speech_output.audio_wavs[i][0].to(torch.float32).cpu(),
sample_rate=speech_output.sample_rate,
)
hyp_file.write(f"{refs[i]}\t{hyps[i]}\t{wav_fp}\n")
else:
hyp_file.write(f"{refs[i]}\t{hyps[i]}\n")
sample_id += 1
progress_bar.update(1)
progress_bar.close()
logger.info(f"Processed {sample_id} samples")
compute_quality_metrics(
output_manifest_tsv_path=model_outputs_tsv,
output_path=output_path,
tgt_lang=ctx.target_lang,
task=ctx.task,
device=ctx.device,
whisper_model_name=whisper_model_name,
)
def main(optional_args: Optional[Dict[str, Any]] = None) -> None:
parser = argparse.ArgumentParser(
description="M4T evaluation for tasks supported by Translator."
)
parser.add_argument(
"--data_file", type=str, help="Data file (.tsv) to be evaluated."
)
parser = add_inference_arguments(parser)
parser.add_argument(
"--batch_size",
type=int,
help="Inference batch size.",
default=4,
)
parser.add_argument(
"--audio_root_dir",
type=str,
help="Root directory for the audio filenames in the data file.",
default="",
)
parser.add_argument(
"--ref_field",
type=str,
help="Reference target text field to compute the BLEU score against.",
default="tgt_text",
)
parser.add_argument(
"--whisper_model_name",
type=str,
help="Whisper model to be used for ASR-BLEU scoring",
default="large",
)
args, unknown = parser.parse_known_args()
default_args = vars(args)
default_args.update(optional_args) if optional_args else default_args
args = Namespace(**default_args)
if not args.data_file or not args.task or not args.tgt_lang:
raise Exception(
"Please provide required arguments for evaluation - data_file, task, tgt_lang"
)
if not Path(args.data_file).exists():
raise ValueError(f"Invalid data_file to be evaluated: {args.data_file}")
input_modality, output_modality = Translator.get_modalities_from_task_str(args.task)
if input_modality == Modality.SPEECH and not Path(args.audio_root_dir).exists():
raise ValueError(
f"Invalid audio_root_dir: {args.audio_root_dir} for speech input."
)
if torch.cuda.is_available():
device = torch.device("cuda:0")
dtype = torch.float16
else:
device = torch.device("cpu")
dtype = torch.float32
text_tokenizer = load_unity_text_tokenizer(args.model_name)
# TODO: Avoid loading the T2U model, vocoder when the output
# modality is text.
translator = Translator(
args.model_name,
args.vocoder_name,
device,
text_tokenizer=text_tokenizer,
dtype=dtype,
input_modality=input_modality,
output_modality=output_modality,
)
text_generation_opts, unit_generation_opts = set_generation_opts(args)
logger.info(f"{text_generation_opts=}")
logger.info(f"{unit_generation_opts=}")
logger.info(
f"unit_generation_ngram_filtering={args.unit_generation_ngram_filtering}"
)
# fmt: off
ctx = EvalContext(
task=args.task,
input_modality=input_modality,
output_modality=output_modality,
model_name=args.model_name,
data_file=Path(args.data_file),
audio_root_dir=Path(args.audio_root_dir),
target_lang=args.tgt_lang,
source_lang=args.src_lang,
batch_size=args.batch_size,
device=device,
dtype=dtype,
ref_field=args.ref_field,
text_generation_opts=text_generation_opts,
unit_generation_opts=unit_generation_opts,
unit_generation_ngram_filtering=args.unit_generation_ngram_filtering,
output_path=args.output_path,
)
# fmt: on
logger.info(f"Running inference on {device=} with {dtype=}, {ctx.batch_size=}.")
run_eval(translator, text_tokenizer, ctx, args.whisper_model_name)
if __name__ == "__main__":
main()
|