Merge pull request #201 from Lux-AI-Challenge/tutorials

RL Tutorials with SB3

Author: StoneT2000

ChangeLog.md

@@ -1,6 +1,11 @@
 # ChangeLog
 
-### v2.0.7
+### v2.1.1
+
+Remove max episode timesteps from gym registration of the Lux AI env. Expect user to specify themselves
+
+
+### v2.1.0
 
 Added [advanced_specs](https://github.com/Lux-AI-Challenge/Lux-Design-S2/blob/main/docs/advanced_specs.md) document that goes over CPU engine code in depth
 

README.md

@@ -42,12 +42,12 @@ Each supported programming language/solution type has its own starter kit, you c
 The kits folder in this repository holds all of the available starter kits you can use to start competing and building an AI agent. The readme shows you how to get started with your language of choice and run a match. We strongly recommend reading through the documentation for your language of choice in the links below
 
 - [Python](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/python/)
+- [Reinforcement Learning (Python)](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/rl/)
 - [C++](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/cpp/)
 - [Javascript](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/js/)
 - [Java](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/java/)
 - [Go](https://github.com/rooklift/golux2/) - (A working bare-bones Go kit)
 - Typescript - TBA
-<!-- - [Reinforcement Learning (Python)](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/rl-sb3/) and [Reinforcement Learning (Python + Jax Env)](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/rl-sb3-jax-env/) -->
 
 
 Want to use another language but it's not supported? Feel free to suggest that language to our issues or even better, create a starter kit for the community to use and make a PR to this repository. See our [CONTRIBUTING.md](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/CONTRIBUTING.md) document for more information on this.
@@ -72,7 +72,7 @@ We are proud to announce our sponsors [QuantCo](https://quantco.com/), [Regressi
 
 ## Core Contributors
 
-We like to extend thanks to some of our early core contributors: [@duanwilliam](https://github.com/duanwilliam) (Frontend), [@programjames](https://github.com/programjames) (Map generation, Engine optimization), and [@themmj](https://github.com/themmj) (C++ kit, Engine optimization).
+We like to extend thanks to some of our early core contributors: [@duanwilliam](https://github.com/duanwilliam) (Frontend), [@programjames](https://github.com/programjames) (Map generation, Engine optimization), and [@themmj](https://github.com/themmj) (C++ kit, Go kit, Engine optimization).
 
 We further like to extend thanks to some of our core contributors during the beta period: [@LeFiz](https://github.com/LeFiz) (Game Design/Architecture), [@jmerle](https://github.com/jmerle) (Visualizer)
 

environment.yml

@@ -11,6 +11,7 @@ dependencies:
   - tqdm
   - yaml
   - gym=0.19
+  - cv2
 
   - pip:
     - pettingzoo

examples/jax_env.py

@@ -1,6 +1,6 @@
 # Lux AI Season 2 Kits
 
-This folder contains all kits for the Lux AI Challenge Season 2. It covers the [Kit Structure](#kit-structure), [Forward Simulation](#forward-simulation), Envionment [Actions](#environment-actions) and [Observations](#environment-observations), as well as the general [Kit API](#kit-api). For those interested in the RL starter kits/baselines, we highly recommend reading those respective docs as they don't use the standard Kit API.
+This folder contains all kits for the Lux AI Challenge Season 2. It covers the [Kit Structure](#kit-structure), [Forward Simulation](#forward-simulation), Envionment [Actions](#environment-actions) and [Observations](#environment-observations), as well as the general [Kit API](#kit-api). For those interested in the [RL starter kits/baselines](https://github.com/Lux-AI-Challenge/Lux-Design-S2/tree/main/kits/rl), we highly recommend reading those respective docs as they don't use the standard Kit API.
 
 In each starter kit folder we give you all the tools necessary to compete. Make sure to read the README document carefully. For debugging, you may log to standard error e.g. `console.error("hello")` or `print("hello", file=sys.stderr)`, and will be recorded by the competition servers.