From ee052e16611cd6ae36fa14c5eb4c7d7e947cf75c Mon Sep 17 00:00:00 2001
From: Tamino Huxohl <thuxohl@techfak.uni-bielefeld.de>
Date: Tue, 27 Sep 2022 10:09:20 +0200
Subject: [PATCH] add some documentation for transforms
---
mu_map/dataset/transform.py | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/mu_map/dataset/transform.py b/mu_map/dataset/transform.py
index c27aaa5..7b2685e 100644
--- a/mu_map/dataset/transform.py
+++ b/mu_map/dataset/transform.py
@@ -5,13 +5,26 @@ from torch import Tensor
class Transform:
+ """
+ Interface of a transformer. A transformer can be initialized and then applied to
+ an input tensor and expected output tensor as returned by a dataset. It can be
+ used for normalization and data augmentation.
+ """
+
def __call__(
self, inputs: Tensor, outputs_expected: Tensor
) -> Tuple[Tensor, Tensor]:
+ """
+ Apply the transformer to a pair of inputs and expected outputs in a dataset.
+ """
return inputs, outputs_expected
class SequenceTransform(Transform):
+ """
+ A transformer that applies a sequence of transformers sequentially.
+ """
+
def __init__(self, transforms: List[Transform]):
self.transforms = transforms
--
GitLab