Incorrect Whisper long-form decoding timestamps (#32003)

* fix lo form timestamps in decode_batch

* Update src/transformers/models/whisper/tokenization_whisper.py

Co-authored-by: Yoach Lacombe <52246514+ylacombe@users.noreply.github.com>

* Update src/transformers/models/whisper/tokenization_whisper.py

Co-authored-by: Yoach Lacombe <52246514+ylacombe@users.noreply.github.com>

* add test

* make style

* fix copies

* Update src/transformers/models/whisper/tokenization_whisper_fast.py

Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>

* Update src/transformers/models/whisper/tokenization_whisper.py

Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>

* Update src/transformers/models/whisper/processing_whisper.py

Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>

* Update src/transformers/models/whisper/tokenization_whisper.py

Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>

* apply review suggestions

* fix

* fix copies

* fix

* Update src/transformers/models/whisper/tokenization_whisper_fast.py

Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>

* fix-copies

---------

Co-authored-by: Yoach Lacombe <52246514+ylacombe@users.noreply.github.com>
Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>
This commit is contained in:
Kamil Akesbi
2024-07-19 09:26:38 +01:00
committed by GitHub
parent 56a7745704
commit cd48553fc8
5 changed files with 133 additions and 25 deletions

View File

@@ -73,7 +73,6 @@ class ClvpProcessor(ProcessorMixin):
inputs["attention_mask"] = encodings["attention_mask"] inputs["attention_mask"] = encodings["attention_mask"]
return inputs return inputs
# Copied from transformers.models.whisper.processing_whisper.WhisperProcessor.batch_decode with Whisper->Clvp
def batch_decode(self, *args, **kwargs): def batch_decode(self, *args, **kwargs):
""" """
This method forwards all its arguments to ClvpTokenizer's [`~PreTrainedTokenizer.batch_decode`]. Please This method forwards all its arguments to ClvpTokenizer's [`~PreTrainedTokenizer.batch_decode`]. Please

View File

@@ -84,6 +84,13 @@ class WhisperProcessor(ProcessorMixin):
This method forwards all its arguments to WhisperTokenizer's [`~PreTrainedTokenizer.batch_decode`]. Please This method forwards all its arguments to WhisperTokenizer's [`~PreTrainedTokenizer.batch_decode`]. Please
refer to the docstring of this method for more information. refer to the docstring of this method for more information.
""" """
# If segments are present in args, we are performing long-form generation and need to return long form timestamps.
# The long-form timestamps are already present in segments and should be passed as kwargs to batch_decode.
if isinstance(args[0], dict) and "segments" in args[0]:
kwargs["longform_timestamps"] = args[0].pop("segments")
args = tuple(args[0]["sequences"].unsqueeze(0))
return self.tokenizer.batch_decode(*args, **kwargs) return self.tokenizer.batch_decode(*args, **kwargs)
def decode(self, *args, **kwargs): def decode(self, *args, **kwargs):

View File

@@ -558,7 +558,7 @@ class WhisperTokenizer(PreTrainedTokenizer):
] ]
return "".join(outputs) return "".join(outputs)
def _compute_offsets(self, token_ids, time_precision=0.02): def _compute_offsets(self, token_ids, time_precision=0.02, longform_timestamps=None):
""" """
Compute offsets for a given tokenized input Compute offsets for a given tokenized input
@@ -567,6 +567,8 @@ class WhisperTokenizer(PreTrainedTokenizer):
List of tokenized input ids. Can be obtained using the `__call__` method. List of tokenized input ids. Can be obtained using the `__call__` method.
time_precision (`float`, `optional`, defaults to 0.02): time_precision (`float`, `optional`, defaults to 0.02):
The time ratio to convert from token to time. The time ratio to convert from token to time.
longform_timestamps (List[dict], *optional*):
Timestamps obtained using long form generation in Whisper, to be used to replace predicted timestamps in token_ids.
""" """
offsets = [] offsets = []
# ensure torch tensor of token ids is placed on cpu # ensure torch tensor of token ids is placed on cpu
@@ -587,7 +589,7 @@ class WhisperTokenizer(PreTrainedTokenizer):
consecutive = np.append(consecutive, np.where(timestamp_tokens)[0][-1] + 1) consecutive = np.append(consecutive, np.where(timestamp_tokens)[0][-1] + 1)
last_slice = np.where(timestamp_tokens)[0][0] last_slice = np.where(timestamp_tokens)[0][0]
for current_slice in consecutive: for i, current_slice in enumerate(consecutive):
sliced_tokens = token_ids[last_slice:current_slice] sliced_tokens = token_ids[last_slice:current_slice]
if len(sliced_tokens) > 1: if len(sliced_tokens) > 1:
start_timestamp_position = sliced_tokens[0].item() - timestamp_begin start_timestamp_position = sliced_tokens[0].item() - timestamp_begin
@@ -596,15 +598,27 @@ class WhisperTokenizer(PreTrainedTokenizer):
sliced_tokens = self._preprocess_token_ids(sliced_tokens) sliced_tokens = self._preprocess_token_ids(sliced_tokens)
text = self._decode(sliced_tokens) text = self._decode(sliced_tokens)
text = self._filter_timestamp_ids(text) text = self._filter_timestamp_ids(text)
offsets.append(
{ if longform_timestamps is not None:
"text": text, offsets.append(
"timestamp": ( {
start_timestamp_position * time_precision, "text": text,
end_timestamp_position * time_precision, "timestamp": (
), longform_timestamps[0][i]["start"].item(),
} longform_timestamps[0][i]["end"].item(),
) ),
}
)
else:
offsets.append(
{
"text": text,
"timestamp": (
start_timestamp_position * time_precision,
end_timestamp_position * time_precision,
),
}
)
last_slice = current_slice last_slice = current_slice
return offsets return offsets
@@ -713,7 +727,11 @@ class WhisperTokenizer(PreTrainedTokenizer):
# retrieve offsets # retrieve offsets
if output_offsets: if output_offsets:
offsets = self._compute_offsets(token_ids, time_precision=time_precision) longform_timestamps = kwargs.get("longform_timestamps")
offsets = self._compute_offsets(
token_ids, time_precision=time_precision, longform_timestamps=longform_timestamps
)
return {"text": text, "offsets": offsets} return {"text": text, "offsets": offsets}
return text return text

View File

@@ -200,7 +200,7 @@ class WhisperTokenizerFast(PreTrainedTokenizerFast):
return "".join(outputs) return "".join(outputs)
# Copied from transformers.models.whisper.tokenization_whisper.WhisperTokenizer._compute_offsets # Copied from transformers.models.whisper.tokenization_whisper.WhisperTokenizer._compute_offsets
def _compute_offsets(self, token_ids, time_precision=0.02): def _compute_offsets(self, token_ids, time_precision=0.02, longform_timestamps=None):
""" """
Compute offsets for a given tokenized input Compute offsets for a given tokenized input
@@ -209,6 +209,8 @@ class WhisperTokenizerFast(PreTrainedTokenizerFast):
List of tokenized input ids. Can be obtained using the `__call__` method. List of tokenized input ids. Can be obtained using the `__call__` method.
time_precision (`float`, `optional`, defaults to 0.02): time_precision (`float`, `optional`, defaults to 0.02):
The time ratio to convert from token to time. The time ratio to convert from token to time.
longform_timestamps (List[dict], *optional*):
Timestamps obtained using long form generation in Whisper, to be used to replace predicted timestamps in token_ids.
""" """
offsets = [] offsets = []
# ensure torch tensor of token ids is placed on cpu # ensure torch tensor of token ids is placed on cpu
@@ -229,7 +231,7 @@ class WhisperTokenizerFast(PreTrainedTokenizerFast):
consecutive = np.append(consecutive, np.where(timestamp_tokens)[0][-1] + 1) consecutive = np.append(consecutive, np.where(timestamp_tokens)[0][-1] + 1)
last_slice = np.where(timestamp_tokens)[0][0] last_slice = np.where(timestamp_tokens)[0][0]
for current_slice in consecutive: for i, current_slice in enumerate(consecutive):
sliced_tokens = token_ids[last_slice:current_slice] sliced_tokens = token_ids[last_slice:current_slice]
if len(sliced_tokens) > 1: if len(sliced_tokens) > 1:
start_timestamp_position = sliced_tokens[0].item() - timestamp_begin start_timestamp_position = sliced_tokens[0].item() - timestamp_begin
@@ -238,15 +240,27 @@ class WhisperTokenizerFast(PreTrainedTokenizerFast):
sliced_tokens = self._preprocess_token_ids(sliced_tokens) sliced_tokens = self._preprocess_token_ids(sliced_tokens)
text = self._decode(sliced_tokens) text = self._decode(sliced_tokens)
text = self._filter_timestamp_ids(text) text = self._filter_timestamp_ids(text)
offsets.append(
{ if longform_timestamps is not None:
"text": text, offsets.append(
"timestamp": ( {
start_timestamp_position * time_precision, "text": text,
end_timestamp_position * time_precision, "timestamp": (
), longform_timestamps[0][i]["start"].item(),
} longform_timestamps[0][i]["end"].item(),
) ),
}
)
else:
offsets.append(
{
"text": text,
"timestamp": (
start_timestamp_position * time_precision,
end_timestamp_position * time_precision,
),
}
)
last_slice = current_slice last_slice = current_slice
return offsets return offsets
@@ -359,7 +373,11 @@ class WhisperTokenizerFast(PreTrainedTokenizerFast):
# retrieve offsets # retrieve offsets
if output_offsets: if output_offsets:
offsets = self._compute_offsets(token_ids, time_precision=time_precision) longform_timestamps = kwargs.get("longform_timestamps")
offsets = self._compute_offsets(
token_ids, time_precision=time_precision, longform_timestamps=longform_timestamps
)
return {"text": text, "offsets": offsets} return {"text": text, "offsets": offsets}
return text return text

View File

@@ -2001,6 +2001,72 @@ class WhisperModelIntegrationTests(unittest.TestCase):
transcript = processor.batch_decode(generated_ids, skip_special_tokens=True, output_offsets=True) transcript = processor.batch_decode(generated_ids, skip_special_tokens=True, output_offsets=True)
self.assertEqual(transcript, EXPECTED_TRANSCRIPT) self.assertEqual(transcript, EXPECTED_TRANSCRIPT)
@slow
def test_tiny_longform_timestamps_generation(self):
set_seed(0)
processor = WhisperProcessor.from_pretrained("openai/whisper-tiny")
model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny")
model.to(torch_device)
sample = self._load_datasamples(1)
input_speech = np.concatenate(sample * 10)
input_features = processor(input_speech, return_tensors="pt", truncation=False, sampling_rate=16_000)
input_features = input_features.to(torch_device)
generated_ids = model.generate(**input_features, return_timestamps=True, return_segments=True)
EXPECTED_TRANSCRIPT = [
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel. Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"offsets": [
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (0.0, 6.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (6.0, 12.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (12.0, 18.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (18.0, 24.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (24.0, 29.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (29.0, 35.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (35.0, 41.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (41.0, 47.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (47.0, 53.0),
},
{
"text": " Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.",
"timestamp": (53.0, 58.20000076293945),
},
],
}
]
transcript = processor.batch_decode(generated_ids, skip_special_tokens=True, output_offsets=True)
self.assertEqual(transcript, EXPECTED_TRANSCRIPT)
@slow @slow
def test_large_timestamp_generation(self): def test_large_timestamp_generation(self):
set_seed(0) set_seed(0)