AITrading

Reinforcement Learning for trading cryptocurrencies, stocks and forex

Python Virtual Environment

Using Conda

https://carpentries-incubator.github.io/introduction-to-conda-for-data-scientists/02-working-with-environments/index.html

Install virtual environment in current project folder

conda create --prefix ./env python=3.8
conda activate ./env
conda remove --prefix /path/to/conda-env/ --all

Install virutal environmenbt in default home folder

conda create --name env_tensortrade python=3.8
conda remove --name my-first-conda-env --all
conda list --name basic-scipy-env

Using Python venv

python3 -m venv <name_of_virtualenv>
virtualenv venv
source ./venv/bin/activate

Documentation

This directory contains the sources (.md and .rst files) for the documentation. The main index page is defined in source/index.rst. The Sphinx options and plugins are found in the source/conf.py file. The documentation is generated in full by calling make html which also automatically generates the Python API documentation from docstrings.

Sphinx and ReadtheDocs

pip install sphinx

pip install sphinx_rtd_theme

pip install --upgrade myst-parser

Create folder for documentation

mkdir docs

cd docs

sphinx-quickstart

make html

Update conf.py

Building documentation locally

Dependencies must be installed using make sync from the project root. Run make docs-build from project root, or make html from the docs/ subfolder (this one).

Note this can take some time as some of the notebooks may be executed during the build process. The resulting documentation is located in the build directory with build/html/index.html marking the homepage.

Sphinx extensions and plugins

We use various Sphinx extensions and plugins to build the documentation:

recommonmark - to handle both .rst and .md
sphinx.ext.napoleon - support extracting Numpy style doctrings for API doc generation
sphinx_autodoc_typehints - support parsing of typehints for API doc generation
sphinxcontrib.apidoc - automatic running of sphinx-apidoc during the build to document API
nbsphinx - parsing Jupyter notebooks to generate static documentation
nbsphinx_link - support linking to notebooks outside of Sphinx source directory via .nblink files