mirror of
https://github.com/k2-fsa/icefall.git
synced 2025-08-09 01:52:41 +00:00
46 lines
1.8 KiB
Python
46 lines
1.8 KiB
Python
# Copyright 2021 Xiaomi Corp. (authors: Fangjun Kuang)
|
|
#
|
|
# See ../../../../LICENSE for clarification regarding multiple authors
|
|
#
|
|
# 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 typing import Tuple
|
|
|
|
import torch
|
|
import torch.nn as nn
|
|
|
|
|
|
class EncoderInterface(nn.Module):
|
|
def forward(
|
|
self, x: torch.Tensor, x_lens: torch.Tensor, warmup_mode: bool
|
|
) -> Tuple[torch.Tensor, torch.Tensor]:
|
|
"""
|
|
Args:
|
|
x:
|
|
A tensor of shape (batch_size, input_seq_len, num_features)
|
|
containing the input features.
|
|
x_lens:
|
|
A tensor of shape (batch_size,) containing the number of frames
|
|
in `x` before padding.
|
|
warmup_mode: for training only, if true then train in
|
|
"warmup mode" (use this for the first few thousand minibatches).
|
|
Returns:
|
|
Return a tuple containing two tensors:
|
|
- encoder_out, a tensor of (batch_size, out_seq_len, output_dim)
|
|
containing unnormalized probabilities, i.e., the output of a
|
|
linear layer.
|
|
- encoder_out_lens, a tensor of shape (batch_size,) containing
|
|
the number of frames in `encoder_out` before padding.
|
|
"""
|
|
raise NotImplementedError("Please implement it in a subclass")
|