add documentation

2023-04-03 17:06:39 +03:00
parent 7b494c8333
commit d9d9993179
3 changed files with 12 additions and 0 deletions
--- a/freqtrade/freqai/base_models/BasePyTorchModel.py
+++ b/freqtrade/freqai/base_models/BasePyTorchModel.py
@@ -76,4 +76,8 @@ class BasePyTorchModel(IFreqaiModel, ABC):
    @property
    @abstractmethod
    def data_convertor(self) -> PyTorchDataConvertor:
+        """
+        a class responsible for converting `*_features` & `*_labels` pandas dataframes
+        to pytorch tensors.
+        """
        raise NotImplementedError("Abstract property")