Table Of Contents
Table Of Contents

Source code for gluonts.block.enc2dec

# Copyright 2018 Amazon.com, Inc. or its affiliates. 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.
# A copy of the License is located at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# or in the "license" file accompanying this file. This file 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.

# Standard library imports
from typing import Tuple

# Third-party imports
from mxnet.gluon import nn

# First-party imports
from gluonts.core.component import validated
from gluonts.model.common import Tensor


[docs]class Seq2SeqEnc2Dec(nn.HybridBlock): """ Abstract class for any module that pass encoder to decoder, such as attention network. """ @validated() def __init__(self, **kwargs): super().__init__(**kwargs) # noinspection PyMethodOverriding
[docs] def hybrid_forward( self, F, encoder_output_static: Tensor, encoder_output_dynamic: Tensor, future_features: Tensor, ) -> Tuple[Tensor, Tensor, Tensor]: """ Parameters ---------- encoder_output_static shape (batch_size, num_features) or (N, C) encoder_output_dynamic shape (batch_size, context_length, num_features) or (N, T, C) future_features shape (batch_size, prediction_length, num_features) or (N, T, C) Returns ------- Tensor shape (batch_size, num_features) or (N, C) Tensor shape (batch_size, prediction_length, num_features) or (N, T, C) Tensor shape (batch_size, sequence_length, num_features) or (N, T, C) """ pass
[docs]class PassThroughEnc2Dec(Seq2SeqEnc2Dec): """ Simplest class for passing encoder tensors do decoder. Passes through tensors. """
[docs] def hybrid_forward( self, F, encoder_output_static: Tensor, encoder_output_dynamic: Tensor, future_features: Tensor, ) -> Tuple[Tensor, Tensor, Tensor]: """ Parameters ---------- encoder_output_static shape (batch_size, num_features) or (N, C) encoder_output_dynamic shape (batch_size, context_length, num_features) or (N, T, C) future_features shape (batch_size, prediction_length, num_features) or (N, T, C) Returns ------- Tensor shape (batch_size, num_features) or (N, C) Tensor shape (batch_size, prediction_length, num_features) or (N, T, C) Tensor shape (batch_size, sequence_length, num_features) or (N, T, C) """ return encoder_output_static, encoder_output_dynamic, future_features