From a8022c104a23f0a25e2fc4f6b65c15746be83824 Mon Sep 17 00:00:00 2001 From: robcaulk Date: Sun, 15 May 2022 14:01:53 +0200 Subject: [PATCH] give beta testers more information in the doc --- docs/freqai.md | 17 +++++++++++++++++ freqtrade/freqai/data_kitchen.py | 2 -- freqtrade/templates/ExamplePredictionModel.py | 4 ++-- 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/freqai.md b/docs/freqai.md index 431705dd9..0fb1fa4c6 100644 --- a/docs/freqai.md +++ b/docs/freqai.md @@ -41,6 +41,23 @@ in the model. intermediate performance of the model during training. This data does not directly influence nodal weights within the model. +## Install prerequisites + +Use `pip` to install the prerequisities with: + +`pip install -r requirements-freqai.txt` + +## Running from the example files + +An example strategy, example prediction model, and example config can all be found in +`freqtrade/templates/ExampleFreqaiStrategy.py`, `freqtrade/templates/ExamplePredictionModel.py`, +`config_examples/config_freqai.example.json`, respectively. Assuming the user has downloaded +the necessary data, Freqai can be executed from these templates with: + +`freqtrade backtesting --config config_examples/config_freqai.example.json--strategy +ExampleFreqaiStrategy --freqaimodel ExamplePredictionModel +--freqaimodel-path freqtrade/templates --strategy-path freqtrade/templates` + ## Configuring the bot ### Example config file The user interface is isolated to the typical config file. A typical Freqai diff --git a/freqtrade/freqai/data_kitchen.py b/freqtrade/freqai/data_kitchen.py index 961f26e57..364b503e9 100644 --- a/freqtrade/freqai/data_kitchen.py +++ b/freqtrade/freqai/data_kitchen.py @@ -113,8 +113,6 @@ class FreqaiDataKitchen: with open(self.model_path / str(self.model_filename + "_metadata.json"), "r") as fp: self.data = json.load(fp) self.training_features_list = self.data["training_features_list"] - # if self.data.get("training_features_list"): - # self.training_features_list = [*self.data.get("training_features_list")] self.data_dictionary["train_features"] = pd.read_pickle( self.model_path / str(self.model_filename + "_trained_df.pkl") diff --git a/freqtrade/templates/ExamplePredictionModel.py b/freqtrade/templates/ExamplePredictionModel.py index 3db8d3aeb..796fb23ed 100644 --- a/freqtrade/templates/ExamplePredictionModel.py +++ b/freqtrade/templates/ExamplePredictionModel.py @@ -42,8 +42,8 @@ class ExamplePredictionModel(IFreqaiModel): def train(self, unfiltered_dataframe: DataFrame, metadata: dict) -> Tuple[DataFrame, DataFrame]: """ - Filter the training data and train a model to it. Train makes heavy use of the datahandler - for storing, saving, loading, and managed. + Filter the training data and train a model to it. Train makes heavy use of the datahkitchen + for storing, saving, loading, and analyzing the data. :params: :unfiltered_dataframe: Full dataframe for the current training period :metadata: pair metadata from strategy.