# Copyright (c) 2023 Predibase, Inc., 2019 Uber Technologies, Inc. # # 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. # ============================================================================== import logging import torch from torch.nn import GRU, LSTM, RNN from ludwig.utils.misc_utils import get_from_registry from ludwig.utils.torch_utils import LudwigModule logger = logging.getLogger(__name__) rnn_layers_registry = { "rnn": RNN, "gru": GRU, "lstm": LSTM, } class RecurrentStack(LudwigModule): def __init__( self, input_size: int | None = None, hidden_size: int = 256, cell_type: str = "rnn", max_sequence_length: int | None = None, num_layers: int = 1, bidirectional: bool = False, use_bias: bool = True, dropout: float = 0.0, **kwargs, ): super().__init__() self.supports_masking = True self.input_size = input_size # api doc: H_in self.hidden_size = hidden_size # api doc: H_out self.max_sequence_length = max_sequence_length # api doc: L (sequence length) rnn_layer_class = get_from_registry(cell_type, rnn_layers_registry) rnn_params = {"num_layers": num_layers, "bias": use_bias, "dropout": dropout, "bidirectional": bidirectional} # Delegate recurrent params to PyTorch's RNN/GRU/LSTM implementations. self.layers = rnn_layer_class(input_size, hidden_size, batch_first=True, **rnn_params) @property def input_shape(self) -> torch.Size: if self.max_sequence_length: return torch.Size([self.max_sequence_length, self.input_size]) return torch.Size([self.input_size]) @property def output_shape(self) -> torch.Size: hidden_size = self.hidden_size * (2 if self.layers.bidirectional else 1) if self.max_sequence_length: return torch.Size([self.max_sequence_length, hidden_size]) return torch.Size([hidden_size]) def forward(self, inputs: torch.Tensor, mask=None): hidden, final_state = self.layers(inputs) if isinstance(final_state, tuple): # lstm cell type final_state = final_state[0][-1], final_state[1][-1] else: # rnn or gru cell type final_state = final_state[-1] return hidden, final_state