refactoring

gianlucamazza · Aug 12, 2024 · 509e53f · 509e53f
1 parent 1b67c74
commit 509e53f
Show file tree

Hide file tree

Showing 15 changed files with 65 additions and 14 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,9 +13,20 @@ LSTM Forecast's documentation
    usage
    modules
 
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   core
+   utils
+   backtesting
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,6 +1,9 @@
 Modules
 =======
 
+API
+---
+
 .. automodule:: lstm_forecast.api.app
     :members:
     :undoc-members:
@@ -21,67 +24,104 @@ Modules
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.cli
+Core
+----
+
+.. automodule:: lstm_forecast.core.data_loader
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.config
+.. automodule:: lstm_forecast.core.feature_engineering
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: lstm_forecast.core.feature_selection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: lstm_forecast.core.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: lstm_forecast.core.predict
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.data_loader
+.. automodule:: lstm_forecast.core.train
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Utils
+-----
+
+.. automodule:: lstm_forecast.utils.early_stopping
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.early_stopping
+.. automodule:: lstm_forecast.utils.hyperparameter_optimization
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.feature_engineering
+.. automodule:: lstm_forecast.utils.logger
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.feature_selection
+.. automodule:: lstm_forecast.utils.model_utils
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.hyperparameter_optimization
+.. automodule:: lstm_forecast.utils.predict_utils
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.logger
+Backtesting
+-----------
+
+.. automodule:: lstm_forecast.backtesting.backtest
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.model
+.. automodule:: lstm_forecast.backtesting.metrics
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.model_utils
+.. automodule:: lstm_forecast.backtesting.plot
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.predict
+.. automodule:: lstm_forecast.backtesting.portfolio
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.predict_utils
+.. automodule:: lstm_forecast.backtesting.trading_engine
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: lstm_forecast.train
+Other
+-----
+
+.. automodule:: lstm_forecast.cli
     :members:
     :undoc-members:
     :show-inheritance:
+
+.. automodule:: lstm_forecast.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/src/lstm_forecast/core/__init__.py b/src/lstm_forecast/core/__init__.py
diff --git a/src/lstm_forecast/data_loader.py → src/lstm_forecast/core/data_loader.py b/src/lstm_forecast/data_loader.py → src/lstm_forecast/core/data_loader.py
diff --git a/src/lstm_forecast/feature_engineering.py → ...lstm_forecast/core/feature_engineering.py b/src/lstm_forecast/feature_engineering.py → ...lstm_forecast/core/feature_engineering.py
diff --git a/src/lstm_forecast/feature_selection.py → src/lstm_forecast/core/feature_selection.py b/src/lstm_forecast/feature_selection.py → src/lstm_forecast/core/feature_selection.py
diff --git a/src/lstm_forecast/model.py → src/lstm_forecast/core/model.py b/src/lstm_forecast/model.py → src/lstm_forecast/core/model.py
diff --git a/src/lstm_forecast/predict.py → src/lstm_forecast/core/predict.py b/src/lstm_forecast/predict.py → src/lstm_forecast/core/predict.py
diff --git a/src/lstm_forecast/train.py → src/lstm_forecast/core/train.py b/src/lstm_forecast/train.py → src/lstm_forecast/core/train.py
diff --git a/src/lstm_forecast/utils/__init__.py b/src/lstm_forecast/utils/__init__.py
diff --git a/src/lstm_forecast/early_stopping.py → src/lstm_forecast/utils/early_stopping.py b/src/lstm_forecast/early_stopping.py → src/lstm_forecast/utils/early_stopping.py
diff --git a/...m_forecast/hyperparameter_optimization.py → ...cast/utils/hyperparameter_optimization.py b/...m_forecast/hyperparameter_optimization.py → ...cast/utils/hyperparameter_optimization.py
diff --git a/src/lstm_forecast/logger.py → src/lstm_forecast/utils/logger.py b/src/lstm_forecast/logger.py → src/lstm_forecast/utils/logger.py
diff --git a/src/lstm_forecast/model_utils.py → src/lstm_forecast/utils/model_utils.py b/src/lstm_forecast/model_utils.py → src/lstm_forecast/utils/model_utils.py
diff --git a/src/lstm_forecast/predict_utils.py → src/lstm_forecast/utils/predict_utils.py b/src/lstm_forecast/predict_utils.py → src/lstm_forecast/utils/predict_utils.py