Merge pull request #18 from huangshiyu13/main

update

Author: huangshiyu13

Makefile

@@ -12,7 +12,7 @@ test:
 lint:
 	$(call check_install, ruff)
 	ruff ${PYTHON_FILES} --select=E9,F63,F7,F82 --show-source
-	ruff ${PYTHON_FILES} --exit-zero
+	ruff ${PYTHON_FILES} --exit-zero | grep -v '501\|405\|401\|402\|403\|722'
 
 format:
 	$(call check_install, isort)

README.md

@@ -44,6 +44,8 @@ For example, you can evaluate tizero with random agent as below:
 tizero eval --left_agent submission/tizero --right_agent submission/random_agent --total_game 10
 ```
 
+For evaluations for JiDi submissions on other games, please refer to the [Arena](https://openrl-docs.readthedocs.io/en/latest/arena/index.html) of OpenRL 
+and this [example](https://github.com/OpenRL-Lab/openrl/tree/main/examples/snake) for the snake game.
 
 ### Show a saved dump file
 

docs/index.rst

@@ -12,11 +12,47 @@ Installation
 ____________
 
 * Follow the instructions in `gfootball <https://github.com/google-research/football#on-your-computer>`_ to set up the environment.
-* ``pip install gfootball``
+* ``pip install gfootball openrl "openrl[selfplay]"``
 * ``pip install tizero`` (or clone this repo and ``pip install -e .`` ).
 * test the installation by ``python3 -m gfootball.play_game --action_set=full`` .
 
 
+Evaluate JiDi submissions locally
+____________
+
+You can evaluate your agent locally using tizero:
+
+.. code-block:: bash
+
+    tizero eval --left_agent submission_dir1 --right_agent submission_dir2 --total_game 10
+
+
+For example, you can evaluate tizero with random agent as below:
+
+.. code-block:: bash
+
+    tizero eval --left_agent submission/tizero --right_agent submission/random_agent --total_game 10
+
+
+For evaluations for JiDi submissions on other games, please refer to the `Arena <https://openrl-docs.readthedocs.io/en/latest/arena/index.html>`_ of OpenRL
+and this `example <https://github.com/OpenRL-Lab/openrl/tree/main/examples/snake>`_ for the snake game.
+
+Show a saved dump file
+____________
+
+* show detailed infomation of a match via: ``tizero show dump_file``
+* show keypoints of a mactch via: ``tizero keypoint dump_file``
+
+You can download an example dump file from `here <http://jidiai.cn/daily_6484285/daily_6484285.dump>`_.
+
+Then execute: ``tizero show daily_6484285.dump`` or ``tizero keypoint daily_6484285.dump`` . Then you will see a GUI as below:
+
+.. image::
+     _static/images/show_dump.png
+     :width: 1000
+     :align: center
+
+
 Convert dump file to video
 ____________
 

tests/test_env.py

@@ -5,7 +5,7 @@ def raw_env():
     from tizero.football_env.football_jidi_eval import FootballJiDiEnv
 
     env = FootballJiDiEnv("11_vs_11_jidi_eval")
-    reset_obs = env.reset()
+    env.reset()
 
     single_action = np.zeros(20)
     single_action[-1] = 1

tizero/football_env/football_jidi_eval.py

@@ -89,7 +89,7 @@ def reset(self):
 
     def add_control_index(self, raw_obs):
         for i, o in enumerate(raw_obs):
-            if not "controlled_player_index" in o:
+            if "controlled_player_index" not in o:
                 o["controlled_player_index"] = i % 11
         return raw_obs
 

tizero/football_env/football_pettingzoo.py

@@ -33,6 +33,7 @@ class FootballAECEnv(AECEnv):
     @property
     def agent_num(self):
         return self.player_each_side
+
     def __init__(self, render_mode: Optional[str] = None, id: str = None):
         self.env = FootballJiDiEnv(scenario_name=id.split("/")[-1])
 

tizero/football_env/scenarios/football_scenario.py

@@ -140,8 +140,8 @@ def test_scenario():
     for i in range(200):
         obs = raw_o[0]
         active_position = obs["left_team"][obs["active"]]
-        sticky_actions = obs["sticky_actions"][:10]
-        active_direction = obs["left_team_direction"][obs["active"]]
+        # sticky_actions = obs["sticky_actions"][:10]
+        # active_direction = obs["left_team_direction"][obs["active"]]
         relative_ball_position = obs["ball"][:2] - active_position
         all_directions_vecs = [
             np.array(v) / np.linalg.norm(np.array(v)) for v in ALL_DIRECTION_VECS

tizero/utils/script_helpers.py

@@ -82,15 +82,15 @@ def load_dump(self, dump_file):
                     return dump
                 dump.append(step)
 
-    def dump_to_txt(self, dump_file, output, include_debug):
-        with open(output, "w") as out_fd:
-            dump = self.load_dump(dump_file)
-        if not include_debug:
-            for s in dump:
-                if "debug" in s:
-                    del s["debug"]
-        with open(output, "w") as f:
-            f.write(str(dump))
+    # def dump_to_txt(self, dump_file, output, include_debug):
+    #     with open(output, "w") as out_fd:
+    #         dump = self.load_dump(dump_file)
+    #     if not include_debug:
+    #         for s in dump:
+    #             if "debug" in s:
+    #                 del s["debug"]
+    #     with open(output, "w") as f:
+    #         f.write(str(dump))
 
     def dump_to_video(self, dump_file, directory=None, episode_length=None):
         dump_path = Path(dump_file)
@@ -124,7 +124,7 @@ def dump_to_video(self, dump_file, directory=None, episode_length=None):
                 processor.update(dump[step])
 
         del processor
-        processor = None
+        # processor = None
 
         avi_files = []
         try_time = 0

tizero/utils/visualize_tools/game_graph/game_graph.py

@@ -286,9 +286,9 @@ def s_step(self):
     def e_step(self):
         return self.subgames[-1].e_step if len(self) > 0 else None
 
-    @property
-    def n_steps(self):
-        return self.e_step - self.s_step + 1
+    # @property
+    # def n_steps(self):
+    #     return self.e_step - self.s_step + 1
 
     @property
     def n_left(self):

tizero/utils/visualize_tools/visualizer/team_info_table.py

@@ -110,10 +110,10 @@ def get_df(self, obs, team, step):
 
         if team == "left":
             roles = self.left_team_roles
-            n = self.n_left
+            # n = self.n_left
         else:
             roles = self.right_team_roles
-            n = self.n_right
+            # n = self.n_right
 
         roles = [SIMPLE_ROLES(r) + str(idx) for idx, r in enumerate(roles)]