From bf859cfbd5c774de379b12d74eac98f2a5bf3872 Mon Sep 17 00:00:00 2001 From: Alex Babescu Date: Sat, 30 Oct 2021 06:57:11 +0100 Subject: [PATCH] Updated readme and envs --- README.md | 34 ++++++++++++++++++++++++++++++++++ environment_cpuonly.yml | 2 ++ environment_cuda.yml | 1 + 3 files changed, 37 insertions(+) diff --git a/README.md b/README.md index 37a86f0..bac83f1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,39 @@ # freqgym +Combining freqtrade with OpenAI Reinforcement Learning environments +## Installation with Conda + +freqgym can be installed with Miniconda or Anaconda. + +### What is Conda? + +Conda is a package, dependency and environment manager for multiple programming languages: [conda docs](https://docs.conda.io/projects/conda/en/latest/index.html) + +### Installation with conda + +Prepare freqgym environment, using file `environment_cpuonly.yml` or `environment_cuda.yml`, which exist in main freqgym directory + +```bash +conda env create -n freqgym -f environment_cpuonly.yml +``` + +#### Enter/exit freqtrade-conda environment + +To check available environments, type + +```bash +conda env list +``` + +Enter installed environment + +```bash +# enter conda environment +conda activate freqgym + +# exit conda environment +conda deactivate +``` Download data with: ` diff --git a/environment_cpuonly.yml b/environment_cpuonly.yml index b73ec4c..0a4ba78 100644 --- a/environment_cpuonly.yml +++ b/environment_cpuonly.yml @@ -1,5 +1,6 @@ name: freqgym channels: + - pytorch - conda-forge # - defaults dependencies: @@ -67,6 +68,7 @@ dependencies: # ============================ # 4/5 req baselines3 - pytorch + - cpuonly - tensorboardx - pip: diff --git a/environment_cuda.yml b/environment_cuda.yml index b692184..d1d0729 100644 --- a/environment_cuda.yml +++ b/environment_cuda.yml @@ -1,5 +1,6 @@ name: freqgym channels: + - pytorch - conda-forge # - defaults dependencies: