Updated readme and envs

AlexBabescu · Oct 30, 2021 · bf859cf · bf859cf
1 parent 7dbd218
commit bf859cf
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git 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
@@ -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
@@ -1,5 +1,6 @@
 name: freqgym
 channels:
+  - pytorch
   - conda-forge
 # - defaults
 dependencies: