Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions tsururu/models/torch_based/layers/convolution.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

torch = OptionalImport("torch")
nn = OptionalImport("torch.nn")
Module = OptionalImport("torch.nn.Module")


class Inception_Block_V1(nn.Module):
class Inception_Block_V1(Module):
"""Inception Block Version 1.

Args:
Expand Down Expand Up @@ -49,7 +50,7 @@ def _initialize_weights(self):
if m.bias is not None:
nn.init.constant_(m.bias, 0)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the Inception block.

Args:
Expand Down
27 changes: 14 additions & 13 deletions tsururu/models/torch_based/layers/embedding.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@

torch = OptionalImport("torch")
nn = OptionalImport("torch.nn")
Module = OptionalImport("torch.nn.Module")


class TokenEmbedding(nn.Module):
class TokenEmbedding(Module):
"""Token embedding layer using 1D convolution.

Args:
Expand All @@ -35,7 +36,7 @@ def __init__(self, c_in: int, d_model: int):
m.weight, mode="fan_in", nonlinearity="leaky_relu"
)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the token embedding.

Args:
Expand All @@ -49,7 +50,7 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
return x


class PositionalEmbedding(nn.Module):
class PositionalEmbedding(Module):
"""Positional encoding using sine and cosine functions.

Args:
Expand All @@ -75,7 +76,7 @@ def __init__(self, d_model: int, max_len: int = 5000):
pe = pe.unsqueeze(0)
self.register_buffer("pe", pe)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the positional embedding.

Args:
Expand All @@ -88,7 +89,7 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.pe[:, : x.size(1)]


class FixedEmbedding(nn.Module):
class FixedEmbedding(Module):
"""Fixed embedding layer using precomputed sine and cosine values.

Args:
Expand All @@ -114,7 +115,7 @@ def __init__(self, c_in: int, d_model: int):
self.emb = nn.Embedding(c_in, d_model)
self.emb.weight = nn.Parameter(w, requires_grad=False)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the fixed embedding.

Args:
Expand All @@ -127,7 +128,7 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.emb(x).detach()


class TemporalEmbedding(nn.Module):
class TemporalEmbedding(Module):
"""Temporal embedding layer for time-related features.

Args:
Expand All @@ -154,7 +155,7 @@ def __init__(self, d_model: int, embed_type: str = "fixed", freq: str = "h"):
self.day_embed = Embed(day_size, d_model)
self.month_embed = Embed(month_size, d_model)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the temporal embedding.

Args:
Expand All @@ -176,7 +177,7 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
return hour_x + weekday_x + day_x + month_x + minute_x


class TimeFeatureEmbedding(nn.Module):
class TimeFeatureEmbedding(Module):
"""Time feature embedding layer using linear transformation.

Args:
Expand All @@ -189,7 +190,7 @@ def __init__(self, d_model: int, d_inp: int = 1):
super(TimeFeatureEmbedding, self).__init__()
self.embed = nn.Linear(d_inp, d_model, bias=False)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the time feature embedding.

Args:
Expand All @@ -202,7 +203,7 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.embed(x)


class Embedding(nn.Module):
class Embedding(Module):
"""Data embedding layer combining token, positional, and temporal embeddings.

Args:
Expand Down Expand Up @@ -251,8 +252,8 @@ def __init__(
self.dropout = nn.Dropout(p=dropout)

def forward(
self, x: torch.Tensor, x_mark: Optional[torch.Tensor] = None
) -> torch.Tensor:
self, x: "torch.Tensor", x_mark: Optional["torch.Tensor"] = None
) -> "torch.Tensor":
"""Forward pass of the data embedding.

Args:
Expand Down
57 changes: 28 additions & 29 deletions tsururu/models/torch_based/layers/patch_tst.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
torch = OptionalImport("torch")
nn = OptionalImport("torch.nn")
F = OptionalImport("torch.nn.functional")
Tensor = OptionalImport("torch.Tensor")
Module = OptionalImport("torch.nn.Module")


Expand Down Expand Up @@ -82,7 +81,7 @@ def __init__(
act: str = "gelu",
key_padding_mask: Union[bool, str] = "auto",
padding_var: Optional[int] = None,
attn_mask: Optional[Tensor] = None,
attn_mask: Optional["torch.Tensor"] = None,
res_attention: bool = True,
pre_norm: bool = False,
store_attn: bool = False,
Expand Down Expand Up @@ -165,7 +164,7 @@ def __init__(
head_dropout=head_dropout,
)

def forward(self, z: Tensor) -> Tensor:
def forward(self, z: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the PatchTST backbone.

Args:
Expand Down Expand Up @@ -329,7 +328,7 @@ def __init__(
store_attn: bool = False,
key_padding_mask: Union[bool, str] = "auto",
padding_var: Optional[int] = None,
attn_mask: Optional[Tensor] = None,
attn_mask: Optional["torch.Tensor"] = None,
res_attention: bool = True,
pre_norm: bool = False,
pe: str = "zeros",
Expand Down Expand Up @@ -381,7 +380,7 @@ def __init__(
store_attn=store_attn,
)

def forward(self, x: Tensor) -> Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass of the TSTi encoder.

Args:
Expand Down Expand Up @@ -423,7 +422,7 @@ def forward(self, x: Tensor) -> Tensor:
return x

@staticmethod
def _reorganize_tensor(x: Tensor, n_vars: int) -> Tensor:
def _reorganize_tensor(x: "torch.Tensor", n_vars: int) -> "torch.Tensor":
"""Reorganizes input tensor to pair time series channels with exogenous features.

Args:
Expand Down Expand Up @@ -522,10 +521,10 @@ def __init__(

def forward(
self,
src: Tensor,
key_padding_mask: Optional[Tensor] = None,
attn_mask: Optional[Tensor] = None,
) -> Tensor:
src: "torch.Tensor",
key_padding_mask: Optional["torch.Tensor"] = None,
attn_mask: Optional["torch.Tensor"] = None,
) -> "torch.Tensor":
"""Forward pass of the TST encoder.

Args:
Expand Down Expand Up @@ -646,11 +645,11 @@ def __init__(

def forward(
self,
src: Tensor,
prev: Optional[Tensor] = None,
key_padding_mask: Optional[Tensor] = None,
attn_mask: Optional[Tensor] = None,
) -> Union[Tensor, Tuple[Tensor, Tensor]]:
src: "torch.Tensor",
prev: Optional["torch.Tensor"] = None,
key_padding_mask: Optional["torch.Tensor"] = None,
attn_mask: Optional["torch.Tensor"] = None,
) -> Union["torch.Tensor", Tuple["torch.Tensor", "torch.Tensor"]]:
"""Forward pass of the TST encoder layer.

Args:
Expand Down Expand Up @@ -769,13 +768,13 @@ def __init__(

def forward(
self,
Q: Tensor,
K: Optional[Tensor] = None,
V: Optional[Tensor] = None,
prev: Optional[Tensor] = None,
key_padding_mask: Optional[Tensor] = None,
attn_mask: Optional[Tensor] = None,
) -> Union[Tensor, Tuple[Tensor, Tensor]]:
Q: "torch.Tensor",
K: Optional["torch.Tensor"] = None,
V: Optional["torch.Tensor"] = None,
prev: Optional["torch.Tensor"] = None,
key_padding_mask: Optional["torch.Tensor"] = None,
attn_mask: Optional["torch.Tensor"] = None,
) -> Union["torch.Tensor", Tuple["torch.Tensor", "torch.Tensor"]]:
"""Forward pass of the multi-head attention layer.

Args:
Expand Down Expand Up @@ -872,13 +871,13 @@ def __init__(

def forward(
self,
q: Tensor,
k: Tensor,
v: Tensor,
prev: Optional[Tensor] = None,
key_padding_mask: Optional[Tensor] = None,
attn_mask: Optional[Tensor] = None,
) -> Union[Tensor, Tuple[Tensor, Tensor, Tensor]]:
q: "torch.Tensor",
k: "torch.Tensor",
v: "torch.Tensor",
prev: Optional["torch.Tensor"] = None,
key_padding_mask: Optional["torch.Tensor"] = None,
attn_mask: Optional["torch.Tensor"] = None,
) -> Union["torch.Tensor", Tuple["torch.Tensor", "torch.Tensor", "torch.Tensor"]]:
"""Forward pass of the scaled dot-product attention.

Args:
Expand Down
2 changes: 1 addition & 1 deletion tsururu/models/torch_based/layers/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Module = OptionalImport("torch.nn.Module")


def get_activation_fn(activation: Union[str, Callable[[], Module]]) -> Module:
def get_activation_fn(activation: Union[str, Callable[[], "Module"]]) -> "Module":
"""Get the activation function based on the provided name or callable.

Args:
Expand Down
7 changes: 4 additions & 3 deletions tsururu/models/torch_based/times_net.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@
nn = OptionalImport("torch.nn")
F = OptionalImport("torch.nn.functional")
rearrange = OptionalImport("einops.rearrange")
Module = OptionalImport("torch.nn.Module")


def FFT_for_Period(x: torch.Tensor, k: int = 2) -> Tuple[np.ndarray, torch.Tensor]:
def FFT_for_Period(x: "torch.Tensor", k: int = 2) -> Tuple[np.ndarray, "torch.Tensor"]:
"""Compute the FFT for the input tensor and find the top-k periods.

Args:
Expand All @@ -41,7 +42,7 @@ def FFT_for_Period(x: torch.Tensor, k: int = 2) -> Tuple[np.ndarray, torch.Tenso
return period, abs(xf).mean(-1)[:, top_list]


class TimesBlock(nn.Module):
class TimesBlock(Module):
"""TimesBlock module for time series forecasting.

Args:
Expand Down Expand Up @@ -75,7 +76,7 @@ def __init__(
Inception_Block_V1(d_ff, d_model, num_kernels=num_kernels),
)

def forward(self, x: torch.Tensor) -> torch.Tensor:
def forward(self, x: "torch.Tensor") -> "torch.Tensor":
"""Forward pass for the TimesBlock module.

Args:
Expand Down
8 changes: 4 additions & 4 deletions tsururu/models/torch_based/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ def adjust_features_groups(


def slice_features(
X: torch.Tensor,
X: "torch.Tensor",
feature_list: List[str],
features_groups_corrected,
) -> torch.Tensor:
) -> "torch.Tensor":
"""Slice the input tensor X based on the corrected feature groups.

Args:
Expand Down Expand Up @@ -90,11 +90,11 @@ def slice_features(


def slice_features_4d(
X: torch.Tensor,
X: "torch.Tensor",
features_list: List[str],
features_groups_corrected,
num_series,
) -> torch.Tensor:
) -> "torch.Tensor":
"""Slice the input tensor X based on the corrected feature groups and reshape it to 4D."""
groups_order: List[str] = [
"series",
Expand Down
4 changes: 2 additions & 2 deletions tsururu/strategies/recursive.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from copy import deepcopy
from typing import Union
from typing import Union, Optional

import pandas as pd

Expand Down Expand Up @@ -211,7 +211,7 @@ def make_step(
def predict(
self,
dataset: TSDataset,
horizon: int | None = None,
horizon: Optional[int] = None,
test_all: bool = False,
inverse_transform: bool = True,
) -> pd.DataFrame:
Expand Down
Loading