Update README.md

README.md

@@ -230,7 +230,7 @@ for it in recognition_result['chunks']:
 
 recognition_result = asr(
     sound_en,
-    generate_kwargs={'task': 'transcribe', 'language': 'english',
+    generate_kwargs={'task': 'transcribe', 'language': 'english'},
     return_timestamps=True
 )
 print('\nRecognized chunks of English speech:')
@@ -256,6 +256,85 @@ Recognized chunks of English speech:
   {'timestamp': (8.96, 20.08), 'text': 'We can decrease variance on basis of large ensemble, large ensemble of different algorithms.'}
 ```
 
+#### Long-form speech recognition
+
+While previous examples demonstrate accurate transcription for audio segments under thirty seconds, practical applications often require processing extensive recordings ranging from several minutes to multiple hours. This necessitates specialized techniques like the sliding window approach to overcome memory constraints and preserve contextual coherence across the entire signal. The following example showcases the model's capability to handle such long-form audio, enabling accurate transcription of lectures, interviews, and meetings.
+
+```python
+import nltk  # for splitting long text into sentences
+from whisper_lid.whisper_lid import detect_language_in_long_speech  # for spoken language detection in long audio
+
+nltk.download('punkt_tab')
+
+long_sound_ru_url = 'https://huggingface.co/bond005/whisper-podlodka-turbo/resolve/main/test_sound_ru_longform.wav'
+long_sound_ru_name = wget.download(long_sound_ru_url)
+long_sound_ru = librosa.load(long_sound_ru_name, sr=target_sampling_rate, mono=True)[0]
+print('Duration of long sound with Russian speech = {0:.3f} seconds.'.format(
+    sound_ru.shape[0] / target_sampling_rate
+))
+
+detected_languages, _ = detect_language_in_long_speech(
+    long_sound_ru,
+    asr.feature_extractor,
+    asr.tokenizer,
+    asr.model
+)
+print('\nTop-3 languages:')
+lang_text_width = max([len(it[0]) for it in detected_languages])
+for it in detected_languages[0:3]:
+    print('  {0:>{1}} {2:.4f}'.format(it[0], lang_text_width, it[1]))
+
+recognition_result = asr(
+    sound_ru_longform,
+    generate_kwargs={
+        'max_new_tokens': 410,
+        'num_beams': 5,  # beam search width (higher values improve accuracy at the cost of increased computation)
+        'condition_on_prev_tokens': False,
+        'compression_ratio_threshold': 2.4,             # used to detect and suppress repetitive loops (a common failure mode)
+        'temperature': (0.0, 0.2, 0.4, 0.6, 0.8, 1.0),  # controls the randomness of token sampling during generation
+        'logprob_threshold': -1.0,   # the threshold for the average log-probability of the generated tokens (provides a filter to exclude low-confidence, potentially erroneous transcriptions)
+        'no_speech_threshold': 0.6,  # threshold for the probability of the `<|nospeech|>` token (segments with a probability above this threshold are considered silent and skipped)
+        'task': 'transcribe',
+        'language': detected_languages[0][0]
+    },
+    return_timestamps=True
+)
+print('\nRecognized text in the long audio, split into sentences:')
+for it in map(lambda sent: sent.strip(), nltk.sent_tokenize(recognition_result['text'])):
+    print(f'  {it}')
+```
+
+As a result, you can see a text output like this:
+
+```text
+Duration of long sound with Russian speech = 148.845 seconds.
+
+Top-3 languages:
+         russian 0.9787
+         english 0.0186
+       ukrainian 0.0006
+
+Recognized text in the long audio, split into sentences:
+  Здравствуйте, друзья!
+  Здравствуйте!
+  Я очень рад вас всех видеть здесь, в этом зале на Хайлооде.
+  Я Иван, как меня уже представили, и я люблю машинное обучение.
+  Я люблю машинное обучение с 2005 года, когда оно проникло в моё сердце ещё, когда я был студентом.
+  С 2006 года я работал в академической сфере, преподавал нейронные сети, искусственный интеллект, машинное обучение своим студентам.
+  С тринадцатого года я перешёл в IT-индустрию, работал в разных компаниях, занимаясь примерно всё тем же машинным обучением и искусством интеллектом.
+  И, наконец, в двадцать втором году мне всё это надоело, я решил обратно из IT-индустрии перейти в академическую сферу.
+  И сейчас я работаю в Новосибирском государственном университете, занимаюсь научными исследованиями, учу студентов, делаем всякие интересные штуки.
+  Ну, а в конце прошлого года я и мои ученики решили всё-таки не только фундаментальными исследованиями заниматься, и наука должна проносить пользу людям, и мы сделали маленький стартап под названием «Сибирские нейросети».
+  То есть, сибирское здоровье и сибирские нейросети теперь.
+  Всё, что я делал, оно связано одним, моей любовью к машинному обучению.
+  Мне это очень интересно было всегда.
+  Ну, а помимо машинного обучения, мне интересно участвовать в соревнованиях.
+  Научные соревнования — это не просто способ развлечься, это способ оценить по гамбургскому счету, насколько твой алгоритм хорош объективно в сравнении с другими.
+  Когда мы разрабатываем какую-то систему для заказчика, мы ориентируемся на его данные, эти данные закрыты, как правило, мы делаем какие-то кастомизации, которые обеспечивают качество, может, даже черепикинг иногда делаем, хотя это фу, но тем не менее.
+  А когда мы предлагаем наши решения, наш научный метод, наш алгоритм на соревновании, мы все в равных условиях, и мы действительно можем оценить, насколько хорошо то или иное решение себя показывает.
+  При этом самое главное, что такие соревнования дают материалы в виде открытых датасетов для дальнейшей воспроизводимости, в виде открытого кода, который, опять-таки, можно воспроизводить в науке, проблема воспроизводимости стоит остро, А подобные научные соревнования, я имею в виду не Кегл, а что-то более интересное и более такое системное, они позволяют действительно какое-то движение науки вперед осуществлять.
+```
+
 #### Voice activity detection (speech/non-speech)
 
 Along with special language tokens, the model can also return the special token `<|nospeech|>`, if the input audio signal does not contain any speech (for details, see section 2.3 of the [corresponding paper about Whisper](https://arxiv.org/pdf/2212.04356)). This skill of the model forms the basis of the speech/non-speech classification algorithm, as demonstrated in the following example: