Lhotse

What's Changed

New tutorials

* Lhotse Shar tutorial notebook by pzelasko in https://github.com/lhotse-speech/lhotse/pull/1006

Recipes

**New**

* CSJ: Faithful Manifest by teowenshen in https://github.com/lhotse-speech/lhotse/pull/940
* himia dataset by glynpu in https://github.com/lhotse-speech/lhotse/pull/991
* Speech Commands v0.01 & v0.02 dataset by yfyeung in https://github.com/lhotse-speech/lhotse/pull/996
* Aishell3 by zjwang21 in https://github.com/lhotse-speech/lhotse/pull/998

**Fixes**
* add dataset-parts argument to libritts by lifeiteng in https://github.com/lhotse-speech/lhotse/pull/956
* Add option to create segments for LibriCSS by desh2608 in https://github.com/lhotse-speech/lhotse/pull/961
* fix tal_csasr data pre-processing by KajiMaCN in https://github.com/lhotse-speech/lhotse/pull/975
* Fix wrong Common Voice parsing by trunglebka in https://github.com/lhotse-speech/lhotse/pull/979
* add the download function of commonvoice command line interface by manbaaaa in https://github.com/lhotse-speech/lhotse/pull/968
* store LJSpeech normalized text by lifeiteng in https://github.com/lhotse-speech/lhotse/pull/988
* LJSpeech strip normalized text by lifeiteng in https://github.com/lhotse-speech/lhotse/pull/992

New features

* Optional quadratic duration correction for dynamic bucketing sampler by pzelasko in https://github.com/lhotse-speech/lhotse/pull/950
* Tentative lhotse --> kaldi manifests conversion for multiple channels by popcornell in https://github.com/lhotse-speech/lhotse/pull/962
* Add RecordingChunkIterableDataset by pzelasko in https://github.com/lhotse-speech/lhotse/pull/985
* Python 3.11 support by pzelasko in https://github.com/lhotse-speech/lhotse/pull/866
* `(cut|recording).dereverb_wpe() API` + more stable numpy version by pzelasko in https://github.com/lhotse-speech/lhotse/pull/1000

General improvements

What's Changed
* Downloading the AMI dataset using CLI will trigger TypeError by JinZr in https://github.com/lhotse-speech/lhotse/pull/919
* AliMeeting recipe enhancement by desh2608 in https://github.com/lhotse-speech/lhotse/pull/909
* fixing alignments by lubacien in https://github.com/lhotse-speech/lhotse/pull/914
* Add room and source RNG seeds option for `reverb_rir` by desh2608 in https://github.com/lhotse-speech/lhotse/pull/920
* Fix serialization for reverb by desh2608 in https://github.com/lhotse-speech/lhotse/pull/927
* Add `trim_to_alignments()` method by desh2608 in https://github.com/lhotse-speech/lhotse/pull/926
* Remove negative duration segments from whisper by desh2608 in https://github.com/lhotse-speech/lhotse/pull/928
* Add `trim_to_supervision_groups` method by desh2608 in https://github.com/lhotse-speech/lhotse/pull/930
* Fix the use of deprecated np.float in numpy>=1.24 by pzelasko in https://github.com/lhotse-speech/lhotse/pull/936
* Remove 'NonPositiveEnergyError' exception when mix audio by drawfish in https://github.com/lhotse-speech/lhotse/pull/922
* minor update for recipes.utils.read_manifests_if_cached by trunglebka in https://github.com/lhotse-speech/lhotse/pull/932
* small pad fix by lubacien in https://github.com/lhotse-speech/lhotse/pull/934
* Unit test that Shar reader is working when shard tar files are named randomly by pzelasko in https://github.com/lhotse-speech/lhotse/pull/937
* [workflow] Multi-talker meeting simulation by desh2608 in https://github.com/lhotse-speech/lhotse/pull/929
* Safe extract for more recipes by desh2608 in https://github.com/lhotse-speech/lhotse/pull/941
* Sampler.filter() preserves previous filters on multiple calls by pzelasko in https://github.com/lhotse-speech/lhotse/pull/944
* Batched feature extraction for s3prl by desh2608 in https://github.com/lhotse-speech/lhotse/pull/942

New Contributors
* lubacien made their first contribution in https://github.com/lhotse-speech/lhotse/pull/914
* trunglebka made their first contribution in https://github.com/lhotse-speech/lhotse/pull/932

**Full Changelog**: https://github.com/lhotse-speech/lhotse/compare/v1.11...v1.12

This release has three new recipes and mostly bug fixes.

What's Changed
* [recipe] DiPCo -- dinner party corpus from Amazon by desh2608 in https://github.com/lhotse-speech/lhotse/pull/893
* [recipe] CHiME-6 dinner party corpus by desh2608 in https://github.com/lhotse-speech/lhotse/pull/895
* [recipe] Add xbmu amdo31 by sendream in https://github.com/lhotse-speech/lhotse/pull/902
* Shar: allow per node+worker randomization of shards order by pzelasko in https://github.com/lhotse-speech/lhotse/pull/905
* Shar: fix shuffling/splitting when cut_map_fn is provided to `CutSet.from_shar` by pzelasko in https://github.com/lhotse-speech/lhotse/pull/907
* Shar: tracking epochs in shard iterator with option for shard re-shuffling each epoch by pzelasko in https://github.com/lhotse-speech/lhotse/pull/894
* Shar: missing param in `CutSet.from_shar` + better error msg by pzelasko in https://github.com/lhotse-speech/lhotse/pull/901
* Fix an edge case with BucketingSampler and a small amount data/buckets by pzelasko in https://github.com/lhotse-speech/lhotse/pull/898
* Remove some deprecated methods by desh2608 in https://github.com/lhotse-speech/lhotse/pull/900
* More details in `cuts.describe()` + fix for `trim_to_unsupervised_segments()` by desh2608 in https://github.com/lhotse-speech/lhotse/pull/899
* Fix save_audios by pkufool in https://github.com/lhotse-speech/lhotse/pull/896
* Fix audio save for parallel workers by pkufool in https://github.com/lhotse-speech/lhotse/pull/903
* Fix bug in load audio (multi-channel) by desh2608 in https://github.com/lhotse-speech/lhotse/pull/906
* Fix SNR sampling error in CutSet.mix by pzelasko in https://github.com/lhotse-speech/lhotse/pull/915

New Contributors
* sendream made their first contribution in https://github.com/lhotse-speech/lhotse/pull/902

**Full Changelog**: https://github.com/lhotse-speech/lhotse/compare/v1.10...v1.11

[experimental] Lhotse Shar -- a modular, sharded, sequential I/O data storage format

This release has a major (experimental) feature called Lhotse Shar. It's a data format inspired by WebDataset tar files that's intended to be very fast for sequential reading of data stored in tarfile shards. It extends the ideas of WebDataset by allowing to store multiple types of features and metadata in separate tar archives that are iterated and loaded together with cuts. It allows to extend existing data with new fields (think different feature extractors, alignments, embeddings, etc.) without triggering a hard copy as would be the case with previous sequential formats supported by Lhotse. Preliminary benchmarking indicated it is as fast as WebDataset both with local disks and cloud storage.

A tutorial notebook about Lhotse Shar is planned to be released later this year.

What's Changed

* Sharded tar writers for Lhotse Shar format by pzelasko in https://github.com/lhotse-speech/lhotse/pull/850
* load ark directly in KaldiReader by csukuangfj in https://github.com/lhotse-speech/lhotse/pull/862
* Add a concrete example showing how to import a Kaldi data directory by csukuangfj in https://github.com/lhotse-speech/lhotse/pull/864
* Fixing shuffling of CutSet with a single cut by Tomiinek in https://github.com/lhotse-speech/lhotse/pull/869
* Fixed an erroneous assertion by JinZr in https://github.com/lhotse-speech/lhotse/pull/874
* Small changes to make channel attribute hashable by desh2608 in https://github.com/lhotse-speech/lhotse/pull/875
* Safe extract tarballs by desh2608 in https://github.com/lhotse-speech/lhotse/pull/876
* Shar: tarfiles now also contain metadata by pzelasko in https://github.com/lhotse-speech/lhotse/pull/870
* Shar: support dynamically attaching custom non-data attributes by pzelasko in https://github.com/lhotse-speech/lhotse/pull/877
* Option not to save cuts in SharWriter by pzelasko in https://github.com/lhotse-speech/lhotse/pull/878
* Minor changes in some recipes by desh2608 in https://github.com/lhotse-speech/lhotse/pull/880
* add ssl feature extractor by DongjiGao in https://github.com/lhotse-speech/lhotse/pull/881
* Shar: a way to attach shard-specific metadata to cuts from each shard by pzelasko in https://github.com/lhotse-speech/lhotse/pull/884
* Always return integer sampling rate when reading audio by pzelasko in https://github.com/lhotse-speech/lhotse/pull/885
* Add option to split AMI segments similar to Kaldi by desh2608 in https://github.com/lhotse-speech/lhotse/pull/889

New Contributors
* JinZr made their first contribution in https://github.com/lhotse-speech/lhotse/pull/874
* DongjiGao made their first contribution in https://github.com/lhotse-speech/lhotse/pull/881

**Full Changelog**: https://github.com/lhotse-speech/lhotse/compare/v1.9...v1.10

Major features

- `MultiCut` data type: simplifies working with multi-channel data (contribution from desh2608)
- CSJ recipe (contribution from teowenshen)
- lots of bug fixes

What's Changed
* create proper wav_id in the segments file for multichannel recording by jtrmal in https://github.com/lhotse-speech/lhotse/pull/831
* kaldi: add an switch/option to read the durations from kaldi utt2dur … by jtrmal in https://github.com/lhotse-speech/lhotse/pull/832
* Update test packages by pzelasko in https://github.com/lhotse-speech/lhotse/pull/837
* `MultiCut` to store multi-channel recordings with shared supervision by desh2608 in https://github.com/lhotse-speech/lhotse/pull/822
* Use CutSet for whisper annotation workflow by desh2608 in https://github.com/lhotse-speech/lhotse/pull/834
* use spawn() as the strategy to prevent heisenbug by jtrmal in https://github.com/lhotse-speech/lhotse/pull/841
* Compatibility for reading alignments saved before Lhotse v1.8 by pzelasko in https://github.com/lhotse-speech/lhotse/pull/842
* make regexp string raw by jtrmal in https://github.com/lhotse-speech/lhotse/pull/836
* Use absolute recording paths in yesno recipe by pzelasko in https://github.com/lhotse-speech/lhotse/pull/845
* Fix CutSet.compute_and_store_features support for lazy CutSets by pzelasko in https://github.com/lhotse-speech/lhotse/pull/844
* Fixing some QA functions for lazy manifests by desh2608 in https://github.com/lhotse-speech/lhotse/pull/848
* Fix timestamps in Whisper annotation workflow by pzelasko in https://github.com/lhotse-speech/lhotse/pull/847
* Update supervisions channels in multi-channel recipes by desh2608 in https://github.com/lhotse-speech/lhotse/pull/838
* Allow retaining or trimming channels in trim_to_supervisions by desh2608 in https://github.com/lhotse-speech/lhotse/pull/852
* Match `cut_id` to `utt_id` if there is exactly one supervision per cut by wgb14 in https://github.com/lhotse-speech/lhotse/pull/853
* forced alignment: use `num2words` to get word timestamps for numbers by eschmidbauer in https://github.com/lhotse-speech/lhotse/pull/849
* Prepare CSJ by teowenshen in https://github.com/lhotse-speech/lhotse/pull/851
* Small changes in `trim_to_supervisions()` by desh2608 in https://github.com/lhotse-speech/lhotse/pull/855
* Fix checkpoints of samplers that were iterated over more than once within the same epoch by pzelasko in https://github.com/lhotse-speech/lhotse/pull/854
* Update fisher_english.py by maxlvov in https://github.com/lhotse-speech/lhotse/pull/858

New Contributors
* eschmidbauer made their first contribution in https://github.com/lhotse-speech/lhotse/pull/849
* teowenshen made their first contribution in https://github.com/lhotse-speech/lhotse/pull/851
* maxlvov made their first contribution in https://github.com/lhotse-speech/lhotse/pull/858

**Full Changelog**: https://github.com/lhotse-speech/lhotse/compare/v1.8...v1.9

Breaking changes

- Python 3.6 is no longer supported as of Lhotse v1.8. If you need to use Python 3.6, please revert to Lhotse 1.7 and earlier.

Highlights

- New experimental module of lhotse: `workflows`, now integrates optional third party packages that assist corpus creators in automated data curation. With release 1.8, we support OpenAI Whisper for automatic transcription and segmentation, and torchaudio Wav2Vec2/Hubert ASR bundles for forced alignment.



What's Changed
* Fix read and write in piped CLI by desh2608 in https://github.com/lhotse-speech/lhotse/pull/807
* Default behavior of CutSet.mix by ZuoyunZheng in https://github.com/lhotse-speech/lhotse/pull/809
* Adding more info about resampling options by RuABraun in https://github.com/lhotse-speech/lhotse/pull/815
* Add `pad_silence` option to `extend_by` by desh2608 in https://github.com/lhotse-speech/lhotse/pull/816
* Message when calling len() on LazyFilter by desh2608 in https://github.com/lhotse-speech/lhotse/pull/817
* Refactor cut and retain `git blame` history by desh2608 in https://github.com/lhotse-speech/lhotse/pull/820
* Audio backend refactoring and a workaround for FLAC reading from/writing to in-memory buffers by pzelasko in https://github.com/lhotse-speech/lhotse/pull/814
* Experimental Lhotse feature: corpus creation tools (``workflows``), starting with OpenAI Whisper support by pzelasko in https://github.com/lhotse-speech/lhotse/pull/824
* Drop support for Python 3.6 by pzelasko in https://github.com/lhotse-speech/lhotse/pull/829
* [workflow] Word-level forced alignment with pretrained models from Torchaudio by pzelasko in https://github.com/lhotse-speech/lhotse/pull/827

New Contributors
* ZuoyunZheng made their first contribution in https://github.com/lhotse-speech/lhotse/pull/809

**Full Changelog**: https://github.com/lhotse-speech/lhotse/compare/v1.7...v1.8