|
| 1 | + |
| 2 | +<h1 align='center'> |
| 3 | + <img src = 'https://github.com/ClementPerroud/Gym-Trading-Env/raw/main/docs/source/images/logo_light-bg.png' width='500'> |
| 4 | +</h1> |
| 5 | + |
| 6 | +<section class="shields" align="center"> |
| 7 | + <a href="https://www.python.org/"> |
| 8 | + <img src="https://img.shields.io/badge/python-v3-brightgreen.svg" |
| 9 | + alt="python"> |
| 10 | + </a> |
| 11 | + <a href="https://pypi.org/project/gym-trading-env/"> |
| 12 | + <img src="https://img.shields.io/badge/pypi-v1.1.3-brightgreen.svg" |
| 13 | + alt="PyPI"> |
| 14 | + </a> |
| 15 | + <a href="https://github.com/ClementPerroud/Gym-Trading-Env/blob/main/LICENSE.txt"> |
| 16 | + <img src="https://img.shields.io/badge/license-MIT%202.0%20Clause-green" |
| 17 | + alt="Apache 2.0 with Commons Clause"> |
| 18 | + </a> |
| 19 | + <a href='https://gym-trading-env.readthedocs.io/en/latest/?badge=latest'> |
| 20 | + <img src='https://readthedocs.org/projects/gym-trading-env/badge/?version=latest' alt='Documentation Status' /> |
| 21 | + </a> |
| 22 | + <a href="https://github.com/ClementPerroud/Gym-Trading-Env"> |
| 23 | + <img src="https://img.shields.io/github/stars/ClementPerroud/gym-trading-env?style=social" alt="Github stars"> |
| 24 | + </a> |
| 25 | +</section> |
| 26 | + |
| 27 | +Cryto Trading Env is an OpenAI Gym environment for simulating stocks and train Reinforcement Learning (RL) trading agents. |
| 28 | +It was designed to be fast and customizable for easy RL trading algorythms implementation. |
| 29 | + |
| 30 | + |
| 31 | +| [Documentation](https://gym-trading-env.readthedocs.io/en/latest/index.html) | |
| 32 | + |
| 33 | + |
| 34 | +Key features |
| 35 | +--------------- |
| 36 | + |
| 37 | +This package aims to greatly simplify the research phase by offering : |
| 38 | + |
| 39 | +* Easy and quick download technical data on several exchanges |
| 40 | +* A simple and fast environment for the user and the AI, but which allows complex operations (Short, Margin trading). |
| 41 | +* A high performance rendering (can display several hundred thousand candles simultaneously), customizable to visualize the actions of its agent and its results. |
| 42 | +* (Coming soon) An easy way to backtest any RL-Agents or any king |
| 43 | + |
| 44 | +.. image:: https://raw.githubusercontent.com/ClementPerroud/Gym-Trading-Env/main/docs/source/images/render.gif |
| 45 | + |
| 46 | +Installation |
| 47 | +--------------- |
| 48 | + |
| 49 | +Crypto Trading Env supports Python 3.9+ on Windows, Mac, and Linux. You can install it using pip: |
| 50 | + |
| 51 | +```bash |
| 52 | +pip install gym-trading-env |
| 53 | +``` |
| 54 | + |
| 55 | +Or using git : |
| 56 | + |
| 57 | +```bash |
| 58 | +git clone https://github.com/ClementPerroud/Gym-Trading-Env |
| 59 | +``` |
| 60 | + |
| 61 | + |
| 62 | +[Documentation available here](https://gym-trading-env.readthedocs.io/en/latest/index.html) |
| 63 | +----------------------------------------------------------------------------------------------- |
0 commit comments