Fix the docs for gym microrts (#211)

* This PR fixes the docs for gym microrts

* Update black version

Author: vwxyzjn

.pre-commit-config.yaml

@@ -24,7 +24,7 @@ repos:
           - --remove-unused-variables
           - --remove-all-unused-imports
   - repo: https://github.com/python/black
-    rev: 21.12b0
+    rev: 22.3.0
     hooks:
       - id: black
         args:

enn_zoo/enn_zoo/codecraft/cc_vec_env.py

@@ -447,7 +447,7 @@ def rules(self) -> Rules:
         #    )
         # else:
         return Rules(
-            mothership_damage_multiplier=2 ** self.config.mothership_damage_scale,
+            mothership_damage_multiplier=2**self.config.mothership_damage_scale,
             cost_modifiers={build: 1.0 for build in self.objective.builds()},
         )
 
@@ -679,7 +679,7 @@ def observe(self, obs_filter: ObsSpace) -> VecObs:
                 start = stride * i + obs_config.endglobals()
                 x = obs[start]
                 y = obs[start + 1]
-                score = -math.sqrt(x ** 2 + y ** 2) / 1000.0
+                score = -math.sqrt(x**2 + y**2) / 1000.0
             elif self.objective == Objective.DISTANCE_TO_CRYSTAL:
                 dstart = stride * i + obs_config.endglobals()
                 xd = obs[dstart]
@@ -691,7 +691,7 @@ def observe(self, obs_filter: ObsSpace) -> VecObs:
                     x = obs[mstart] - xd
                     y = obs[mstart + 1] - yd
                     size = obs[mstart + 2]
-                    nearness = 0.5 - math.sqrt(x ** 2 + y ** 2) / 1000.0
+                    nearness = 0.5 - math.sqrt(x**2 + y**2) / 1000.0
                     score = max(score, 0.2 * nearness * size)
             elif self.objective in [Objective.DISTANCE_TO_1000_500]:
 

enn_zoo/enn_zoo/microrts/README.md

@@ -10,46 +10,46 @@ Prerequisites:
 Run an experiment locally
 
 ```bash
-poetry run python enn_ppo/enn_ppo/train.py \
+poetry run python enn_zoo/enn_zoo/train.py \
     env.id=GymMicrorts \
-    env.num_envs=4 \
+    rollout.num_envs=4 \
     total_timesteps=100000 \
-    env.num_steps=256
+    rollout.steps=256
 ```
 
 Run a different map. See [here](https://github.com/vwxyzjn/microrts/tree/master/maps/16x16) for a full list of maps.
 ```bash
-poetry run python enn_ppo/enn_ppo/train.py \
+poetry run python enn_zoo/enn_zoo/train.py \
     env.id=GymMicrorts \
-    env.num_envs=4 \
+    rollout.num_envs=4 \
     total_timesteps=100000 \
-    env.num_steps=256 \
+    rollout.steps=256 \
     env.kwargs="{\"map_path\": \"maps/16x16/basesWorkers16x16.xml\"}"
 ```
 
 
 Run a tracked experiment
 
 ```bash
-poetry run python enn_ppo/enn_ppo/train.py \
+poetry run python enn_zoo/enn_zoo/train.py \
     env.id=GymMicrorts \
-    env.num_envs=24 \
+    rollout.num_envs=24 \
     total_timesteps=100000 \
-    env.num_steps=256 \
+    rollout.steps=256 \
     track=true
 ```
 
 Run a tracked experiment with video tracking
 
 ```
-poetry run python enn_ppo/enn_ppo/train.py \
+poetry run python enn_zoo/enn_zoo/train.py \
     env.id=GymMicrorts \
-    env.num_envs=1 \
+    rollout.num_envs=1 \
     total_timesteps=10000 \
-    env.num_steps=256 \
+    rollout.steps=256 \
     eval.capture_videos=true \
     eval.steps=500 \
-    eval.num_envs=1 \
+    rollout.num_envs=1 \
     eval.interval=10000 \
     track=true
 ```

entity_gym/entity_gym/examples/move_to_origin.py

@@ -138,7 +138,7 @@ def observe(self, done: bool = False) -> Observation:
                 "horizontal_thruster": CategoricalActionMask(),
                 "vertical_thruster": CategoricalActionMask(),
             },
-            reward=(self.last_x_pos ** 2 + self.last_y_pos ** 2) ** 0.5
-            - (self.x_pos ** 2 + self.y_pos ** 2) ** 0.5,
+            reward=(self.last_x_pos**2 + self.last_y_pos**2) ** 0.5
+            - (self.x_pos**2 + self.y_pos**2) ** 0.5,
             done=done,
         )