Merge pull request #99 from FLAIROx/jaxnav

JaxNav, base class update, version increment, scipy bound

CHANGELOG.md

@@ -1,4 +1,16 @@
-### [v0.0.1] - DATE
+### [v0.0.4]
+
+#### Added
+ - Reset to specific state within environment base class
+ - JaxNav environment
+
+
+### [v0.0.3]
+
+#### Added
+ - Hanabi bug fixes
+
+### [v0.0.1]
 
 ##### Added
  - base set of environments and algorithms

CONTRIBUTING.md

@@ -35,4 +35,5 @@ All contributions will fall under the project's original license.
 ## Roadmap
 
 Some improvements we would like to see implemented:
-- [ ] improved RNN implementations. In the current implementation, the hidden size is dependent on "NUM_STEPS", it should be made independent. Speed could also be improved with an S5 architecture.
+- [x] improved RNN implementations. In the current implementation, the hidden size is dependent on "NUM_STEPS", it should be made independent. 
+- [ ] S5 RNN architecture.

Dockerfile

@@ -10,14 +10,15 @@ USER ${MYUSER}
 WORKDIR /home/${MYUSER}/
 COPY --chown=${MYUSER} --chmod=765 . .
 
-#jaxmarl from source if needed, all the requirements
 USER root
-RUN pip install -e .
 
 # install tmux
 RUN apt-get update && \
     apt-get install -y tmux
 
+#jaxmarl from source if needed, all the requirements
+RUN pip install -e .
+
 USER ${MYUSER}
 
 #disabling preallocation

README.md

@@ -28,7 +28,7 @@
         <div class="row" align="centre">
             <img src="https://github.com/FLAIROx/JaxMARL/blob/main/docs/imgs/coin_game.png?raw=true" alt="coin_game" width="20%">
             <img src="https://github.com/FLAIROx/JaxMARL/blob/main/docs/imgs/qmix_MPE_simple_tag_v3.gif?raw=true" alt="MPE" width="20%">
-            <img src="https://github.com/FLAIROx/JaxMARL/blob/main/docs/imgs/switch_riddle.png?raw=true" alt="switch_riddle" width="20%">
+            <img src="https://github.com/FLAIROx/JaxMARL/blob/main/docs/imgs/jaxnav-ma.gif?raw=true" alt="jaxnav" width="20%">
             <img src="https://github.com/FLAIROx/JaxMARL/blob/main/docs/imgs/smax.gif?raw=true" alt="SMAX" width="20%">
         </div>
     </div>
@@ -50,6 +50,7 @@ For more details, take a look at our [blog post](https://blog.foersterlab.com/ja
 | 🎆 Hanabi | [Paper](https://arxiv.org/abs/1902.00506) | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/hanabi) | Fully-cooperative partially-observable multiplayer card game |
 | 👾 SMAX | Novel | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/smax) | Simplified cooperative StarCraft micro-management environment |
 | 🧮 STORM: Spatial-Temporal Representations of Matrix Games | [Paper](https://openreview.net/forum?id=54F8woU8vhq) | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/storm) | Matrix games represented as grid world scenarios
+| 🧭 JaxNav | Paper coming | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/jaxnav) | 2D geometric navigation for differential drive robots
 | 🪙 Coin Game | [Paper](https://arxiv.org/abs/1802.09640) | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/coin_game) | Two-player grid world environment which emulates social dilemmas
 | 💡 Switch Riddle | [Paper](https://proceedings.neurips.cc/paper_files/paper/2016/hash/c7635bfd99248a2cdef8249ef7bfbef4-Abstract.html) | [Source](https://github.com/FLAIROx/JaxMARL/tree/main/jaxmarl/environments/switch_riddle) | Simple cooperative communication game included for debugging
 

jaxmarl/__init__.py

@@ -1,4 +1,4 @@
 from .registration import make, registered_envs
 
 __all__ = ["make", "registered_envs"]
-__version__ = "0.0.3"
+__version__ = "0.0.4"

jaxmarl/environments/__init__.py

@@ -21,4 +21,5 @@
 from .hanabi import Hanabi
 from .storm import InTheGrid, InTheGrid_2p
 from .coin_game import CoinGame
+from .jaxnav import JaxNav
 

jaxmarl/environments/jaxnav/README.md

@@ -0,0 +1,5 @@
+# 🧭 JaxNav 
+
+2D geometric navigation for differential drive robots. Using distances readings to nearby obstacles (mimicing LiDAR readings), the direction to their goal and their current velocity, robots must navigate to their goal without colliding with obstacles.
+
+MORE TO COME.

jaxmarl/environments/jaxnav/__init__.py

@@ -0,0 +1,2 @@
+from .jaxnav_env import JaxNav
+from .jaxnav_singletons import make_jaxnav_singleton, make_jaxnav_singleton_collection, JaxNavSingleton