From 852a470777b08fceb1b8e1e1b954b6dc028572a2 Mon Sep 17 00:00:00 2001 From: Ludovico Lemma <89784228+ludovicolemma@users.noreply.github.com> Date: Fri, 12 Aug 2022 22:32:15 +0200 Subject: [PATCH] Update README.rst --- README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7413dba..980c411 100644 --- a/README.rst +++ b/README.rst @@ -49,6 +49,14 @@ The following parameters are optional: NB: Currently the training is set to be performed on 30 time_stamps, thus having close or fewer days than 30 may cause some unexpected errors +**Usage example:** + +.. code:: sh + + price_predictor EURUSD=X -d 2021-09-01 -r 0.9 -l 2 -e 15 + +Meaning: Return tomorrow's EUR/USD opening price after training on data from the 1st of September 2021, with 90% of those data dedicated to training, the LSTM RNN will have 2 layers and the epochs of training will be 15 + Documentation ------------- @@ -199,8 +207,6 @@ It is better to use this tool with financial instruments without a history of su A possible solution to this problem is changing the starting date from which to gather data, so that the model may not be biased towards past averaage prices, or to increase the training to test split ratio (use with care!). -It is also possible some tensorflow warnings may be given using the command-line with some OS without correct GPU drivers - Disclaimer ----------