From 5fde331553a1d06b47fd86b9dc40ebcd6ba24ee5 Mon Sep 17 00:00:00 2001
From: "Dr. Kashif Rasul" <kashif.rasul@gmail.com>
Date: Mon, 18 Nov 2019 16:06:19 +0100
Subject: [PATCH] added doc

---
 pts/model/deepar/deepar_network.py | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/pts/model/deepar/deepar_network.py b/pts/model/deepar/deepar_network.py
index 05b33f6..0d3a413 100644
--- a/pts/model/deepar/deepar_network.py
+++ b/pts/model/deepar/deepar_network.py
@@ -75,7 +75,26 @@ class DeepARNetwork(nn.Module):
         indices: List[int],
         subsequences_length: int = 1,
     ) -> torch.Tensor:
-
+        """
+        Returns lagged subsequences of a given sequence.
+        Parameters
+        ----------
+        sequence : Tensor
+            the sequence from which lagged subsequences should be extracted.
+            Shape: (N, T, C).
+        sequence_length : int
+            length of sequence in the T (time) dimension (axis = 1).
+        indices : List[int]
+            list of lag indices to be used.
+        subsequences_length : int
+            length of the subsequences to be extracted.
+        Returns
+        --------
+        lagged : Tensor
+            a tensor of shape (N, S, C, I), where S = subsequences_length and
+            I = len(indices), containing lagged subsequences. Specifically,
+            lagged[i, j, :, k] = sequence[i, -indices[k]-S+j, :].
+        """
         assert max(indices) + subsequences_length <= sequence_length, (
             f"lags cannot go further than history length, found lag {max(indices)} "
             f"while history length is only {sequence_length}"