Update to make a package

Author: ClementPerroud

.gitignore

@@ -1,3 +1,8 @@
 __pycache__
+dist
 .ipynbcheckpoints
-my_example.py
+
+my_example.py
+pyproject.toml
+.pypirc
+*.egg-info

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -93,6 +93,13 @@ while not truncated:
     action = env.action_space.sample()
     observation, reward, done, truncated, info = env.step(action)
 ```
+- ```observation``` returns a dict with items :
+    - ```features``` : Contains the features created. If windows is None, it contains the features of the current step (shape = (n_features,)). If windows is i (int), it contains the features the last i steps (shape = (5, n_features)).
+    - ```position``` : The last position of the environments. It can be useful to include this to the features, so the agent knows which position he is holding and gains stability and continuity.
+- ```reward``` : The step reward following the action taken.
+- ```done```: Always False.
+- ```truncated``` : Is true if we reached the end of the DataFrame.
+- ```info``` : Return the last history step of the object "history" presented above (in "3 - Create your own reward function")
 **(Optional) 6 - Render**
 
 Performed with Dash Plotly (local app).

environments/__init__.py src/environments/__init__.py

@@ -1,6 +1,9 @@
+import sys  
+sys.path.append("./")
+
 import pandas as pd
 import numpy as np
-from environments import TradingEnv
+from src.environments import TradingEnv
 import time
 
 # Import your datas