# Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from collections import OrderedDict from typing import List import numpy as np from deepspeech.frontend.augmentor.augmentation import AugmentationPipeline from deepspeech.utils.log import Log __all__ = ["pad_list", "pad_sequence", "LoadInputsAndTargets"] logger = Log(__name__).getlog() def pad_list(sequences: List[np.ndarray], padding_value: float=0.0) -> np.ndarray: return pad_sequence(sequences, True, padding_value) def pad_sequence(sequences: List[np.ndarray], batch_first: bool=True, padding_value: float=0.0) -> np.ndarray: r"""Pad a list of variable length Tensors with ``padding_value`` ``pad_sequence`` stacks a list of Tensors along a new dimension, and pads them to equal length. For example, if the input is list of sequences with size ``L x *`` and if batch_first is False, and ``T x B x *`` otherwise. `B` is batch size. It is equal to the number of elements in ``sequences``. `T` is length of the longest sequence. `L` is length of the sequence. `*` is any number of trailing dimensions, including none. Example: >>> a = np.ones([25, 300]) >>> b = np.ones([22, 300]) >>> c = np.ones([15, 300]) >>> pad_sequence([a, b, c]).shape [25, 3, 300] Note: This function returns a np.ndarray of size ``T x B x *`` or ``B x T x *`` where `T` is the length of the longest sequence. This function assumes trailing dimensions and type of all the Tensors in sequences are same. Args: sequences (list[np.ndarray]): list of variable length sequences. batch_first (bool, optional): output will be in ``B x T x *`` if True, or in ``T x B x *`` otherwise padding_value (float, optional): value for padded elements. Default: 0. Returns: np.ndarray of size ``T x B x *`` if :attr:`batch_first` is ``False``. np.ndarray of size ``B x T x *`` otherwise """ # assuming trailing dimensions and type of all the Tensors # in sequences are same and fetching those from sequences[0] max_size = sequences[0].shape trailing_dims = max_size[1:] max_len = max([s.shape[0] for s in sequences]) if batch_first: out_dims = (len(sequences), max_len) + trailing_dims else: out_dims = (max_len, len(sequences)) + trailing_dims out_tensor = np.full(out_dims, padding_value, dtype=sequences[0].dtype) for i, tensor in enumerate(sequences): length = tensor.shape[0] # use index notation to prevent duplicate references to the tensor if batch_first: out_tensor[i, :length, ...] = tensor else: out_tensor[:length, i, ...] = tensor return out_tensor class LoadInputsAndTargets(): """Create a mini-batch from a list of dicts >>> batch = [('utt1', ... dict(input=[dict(feat='some.ark:123', ... filetype='mat', ... name='input1', ... shape=[100, 80])], ... output=[dict(tokenid='1 2 3 4', ... name='target1', ... shape=[4, 31])]])) >>> l = LoadInputsAndTargets() >>> feat, target = l(batch) :param: str mode: Specify the task mode, "asr" or "tts" :param: str preprocess_conf: The path of a json file for pre-processing :param: bool load_input: If False, not to load the input data :param: bool load_output: If False, not to load the output data :param: bool sort_in_input_length: Sort the mini-batch in descending order of the input length :param: bool use_speaker_embedding: Used for tts mode only :param: bool use_second_target: Used for tts mode only :param: dict preprocess_args: Set some optional arguments for preprocessing :param: Optional[dict] preprocess_args: Used for tts mode only """ def __init__( self, mode="asr", preprocess_conf=None, load_input=True, load_output=True, sort_in_input_length=True, preprocess_args=None, keep_all_data_on_mem=False, ): self._loaders = {} if mode not in ["asr"]: raise ValueError("Only asr are allowed: mode={}".format(mode)) if preprocess_conf is not None: self.preprocessing = AugmentationPipeline(preprocess_conf) logging.warning( "[Experimental feature] Some preprocessing will be done " "for the mini-batch creation using {}".format( self.preprocessing)) else: # If conf doesn't exist, this function don't touch anything. self.preprocessing = None self.mode = mode self.load_output = load_output self.load_input = load_input self.sort_in_input_length = sort_in_input_length if preprocess_args is None: self.preprocess_args = {} else: assert isinstance(preprocess_args, dict), type(preprocess_args) self.preprocess_args = dict(preprocess_args) self.keep_all_data_on_mem = keep_all_data_on_mem def __call__(self, batch, return_uttid=False): """Function to load inputs and targets from list of dicts :param List[Tuple[str, dict]] batch: list of dict which is subset of loaded data.json :param bool return_uttid: return utterance ID information for visualization :return: list of input token id sequences [(L_1), (L_2), ..., (L_B)] :return: list of input feature sequences [(T_1, D), (T_2, D), ..., (T_B, D)] :rtype: list of float ndarray :return: list of target token id sequences [(L_1), (L_2), ..., (L_B)] :rtype: list of int ndarray """ x_feats_dict = OrderedDict() # OrderedDict[str, List[np.ndarray]] y_feats_dict = OrderedDict() # OrderedDict[str, List[np.ndarray]] uttid_list = [] # List[str] for uttid, info in batch: uttid_list.append(uttid) if self.load_input: # Note(kamo): This for-loop is for multiple inputs for idx, inp in enumerate(info["input"]): # {"input": # [{"feat": "some/path.h5:F01_050C0101_PED_REAL", # "filetype": "hdf5", # "name": "input1", ...}], ...} x = self._get_from_loader( filepath=inp["feat"], filetype=inp.get("filetype", "mat")) x_feats_dict.setdefault(inp["name"], []).append(x) if self.load_output: for idx, inp in enumerate(info["output"]): if "tokenid" in inp: # ======= Legacy format for output ======= # {"output": [{"tokenid": "1 2 3 4"}]) x = np.fromiter( map(int, inp["tokenid"].split()), dtype=np.int64) else: # ======= New format ======= # {"input": # [{"feat": "some/path.h5:F01_050C0101_PED_REAL", # "filetype": "hdf5", # "name": "target1", ...}], ...} x = self._get_from_loader( filepath=inp["feat"], filetype=inp.get("filetype", "mat")) y_feats_dict.setdefault(inp["name"], []).append(x) if self.mode == "asr": return_batch, uttid_list = self._create_batch_asr( x_feats_dict, y_feats_dict, uttid_list) else: raise NotImplementedError(self.mode) if self.preprocessing is not None: # Apply pre-processing all input features for x_name in return_batch.keys(): if x_name.startswith("input"): return_batch[x_name] = self.preprocessing( return_batch[x_name], uttid_list, **self.preprocess_args) if return_uttid: return tuple(return_batch.values()), uttid_list # Doesn't return the names now. return tuple(return_batch.values()) def _create_batch_asr(self, x_feats_dict, y_feats_dict, uttid_list): """Create a OrderedDict for the mini-batch :param OrderedDict x_feats_dict: e.g. {"input1": [ndarray, ndarray, ...], "input2": [ndarray, ndarray, ...]} :param OrderedDict y_feats_dict: e.g. {"target1": [ndarray, ndarray, ...], "target2": [ndarray, ndarray, ...]} :param: List[str] uttid_list: Give uttid_list to sort in the same order as the mini-batch :return: batch, uttid_list :rtype: Tuple[OrderedDict, List[str]] """ # handle single-input and multi-input (paralell) asr mode xs = list(x_feats_dict.values()) if self.load_output: ys = list(y_feats_dict.values()) assert len(xs[0]) == len(ys[0]), (len(xs[0]), len(ys[0])) # get index of non-zero length samples nonzero_idx = list( filter(lambda i: len(ys[0][i]) > 0, range(len(ys[0])))) for n in range(1, len(y_feats_dict)): nonzero_idx = filter(lambda i: len(ys[n][i]) > 0, nonzero_idx) else: # Note(kamo): Be careful not to make nonzero_idx to a generator nonzero_idx = list(range(len(xs[0]))) if self.sort_in_input_length: # sort in input lengths based on the first input nonzero_sorted_idx = sorted( nonzero_idx, key=lambda i: -len(xs[0][i])) else: nonzero_sorted_idx = nonzero_idx if len(nonzero_sorted_idx) != len(xs[0]): logging.warning( "Target sequences include empty tokenid (batch {} -> {}).". format(len(xs[0]), len(nonzero_sorted_idx))) # remove zero-length samples xs = [[x[i] for i in nonzero_sorted_idx] for x in xs] uttid_list = [uttid_list[i] for i in nonzero_sorted_idx] x_names = list(x_feats_dict.keys()) if self.load_output: ys = [[y[i] for i in nonzero_sorted_idx] for y in ys] y_names = list(y_feats_dict.keys()) # Keeping x_name and y_name, e.g. input1, for future extension return_batch = OrderedDict([ * [(x_name, x) for x_name, x in zip(x_names, xs)], * [(y_name, y) for y_name, y in zip(y_names, ys)], ]) else: return_batch = OrderedDict( [(x_name, x) for x_name, x in zip(x_names, xs)]) return return_batch, uttid_list def _get_from_loader(self, filepath, filetype): """Return ndarray In order to make the fds to be opened only at the first referring, the loader are stored in self._loaders >>> ndarray = loader.get_from_loader( ... 'some/path.h5:F01_050C0101_PED_REAL', filetype='hdf5') :param: str filepath: :param: str filetype: :return: :rtype: np.ndarray """ if filetype == "hdf5": # e.g. # {"input": [{"feat": "some/path.h5:F01_050C0101_PED_REAL", # "filetype": "hdf5", # -> filepath = "some/path.h5", key = "F01_050C0101_PED_REAL" filepath, key = filepath.split(":", 1) loader = self._loaders.get(filepath) if loader is None: # To avoid disk access, create loader only for the first time loader = h5py.File(filepath, "r") self._loaders[filepath] = loader return loader[key][()] elif filetype == "sound.hdf5": # e.g. # {"input": [{"feat": "some/path.h5:F01_050C0101_PED_REAL", # "filetype": "sound.hdf5", # -> filepath = "some/path.h5", key = "F01_050C0101_PED_REAL" filepath, key = filepath.split(":", 1) loader = self._loaders.get(filepath) if loader is None: # To avoid disk access, create loader only for the first time loader = SoundHDF5File(filepath, "r", dtype="int16") self._loaders[filepath] = loader array, rate = loader[key] return array elif filetype == "sound": # e.g. # {"input": [{"feat": "some/path.wav", # "filetype": "sound"}, # Assume PCM16 if not self.keep_all_data_on_mem: array, _ = soundfile.read(filepath, dtype="int16") return array if filepath not in self._loaders: array, _ = soundfile.read(filepath, dtype="int16") self._loaders[filepath] = array return self._loaders[filepath] elif filetype == "npz": # e.g. # {"input": [{"feat": "some/path.npz:F01_050C0101_PED_REAL", # "filetype": "npz", filepath, key = filepath.split(":", 1) loader = self._loaders.get(filepath) if loader is None: # To avoid disk access, create loader only for the first time loader = np.load(filepath) self._loaders[filepath] = loader return loader[key] elif filetype == "npy": # e.g. # {"input": [{"feat": "some/path.npy", # "filetype": "npy"}, if not self.keep_all_data_on_mem: return np.load(filepath) if filepath not in self._loaders: self._loaders[filepath] = np.load(filepath) return self._loaders[filepath] elif filetype in ["mat", "vec"]: # e.g. # {"input": [{"feat": "some/path.ark:123", # "filetype": "mat"}]}, # In this case, "123" indicates the starting points of the matrix # load_mat can load both matrix and vector if not self.keep_all_data_on_mem: return kaldiio.load_mat(filepath) if filepath not in self._loaders: self._loaders[filepath] = kaldiio.load_mat(filepath) return self._loaders[filepath] elif filetype == "scp": # e.g. # {"input": [{"feat": "some/path.scp:F01_050C0101_PED_REAL", # "filetype": "scp", filepath, key = filepath.split(":", 1) loader = self._loaders.get(filepath) if loader is None: # To avoid disk access, create loader only for the first time loader = kaldiio.load_scp(filepath) self._loaders[filepath] = loader return loader[key] else: raise NotImplementedError( "Not supported: loader_type={}".format(filetype))