Update colab to match pettingZoo import api

Author: maryamhonari

pettingzoo-unity/Colab_PettingZoo.ipynb

@@ -1,53 +1,47 @@
 {
- "nbformat": 4,
- "nbformat_minor": 0,
- "metadata": {
-  "colab": {
-   "name": "Colab-UnityEnvironment-1-Run.ipynb",
-   "private_outputs": true,
-   "provenance": [],
-   "collapsed_sections": [],
-   "toc_visible": true
-  },
-  "kernelspec": {
-   "name": "python3",
-   "display_name": "Python 3.7.11 64-bit ('pettingzoo': conda)",
-   "metadata": {
-    "interpreter": {
-     "hash": "5d8bf1ccad4050d475e9ef008ff2de5ee0b8bb440e3e2ef203ad7e8f5a9e706b"
-    }
-   }
-  },
-  "pycharm": {
-   "stem_cell": {
-    "cell_type": "raw",
-    "source": [],
-    "metadata": {
-     "collapsed": false
-    }
-   }
-  }
- },
  "cells": [
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "# ML-Agents PettingZoo Wrapper"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "## Setup"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "\n",
+       "        <progress\n",
+       "            value='100'\n",
+       "            max='100',\n",
+       "            style='width: 100%'\n",
+       "        >\n",
+       "            100\n",
+       "        </progress>\n",
+       "    "
+      ],
+      "text/plain": [
+       "<IPython.core.display.HTML object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
    "source": [
     "#@title Install Rendering Dependencies { display-mode: \"form\" }\n",
     "#@markdown (You only need to run this code when using Colab's hosted runtime)\n",
@@ -125,17 +119,25 @@
    ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Installing ml-agents"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "ml-agents already installed\n"
+     ]
+    }
+   ],
    "source": [
     "try:\n",
     "  import mlagents\n",
@@ -149,36 +151,59 @@
    ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "## Run the Environment"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
-   "cell_type": "code",
+   "cell_type": "markdown",
    "metadata": {
-    "id": "htb-p1hSNX7D"
+    "jp-MarkdownHeadingCollapsed": true,
+    "tags": []
    },
    "source": [
-    "#@title Select Environment { display-mode: \"form\" }\n",
-    "env_id = \"StrikersVsGoalie\" #@param ['Basic', '3DBall', '3DBallHard', 'GridWorld', 'Hallway', 'VisualHallway', 'CrawlerDynamicTarget', 'CrawlerStaticTarget', 'Bouncer', 'SoccerTwos', 'PushBlock', 'VisualPushBlock', 'WallJump', 'Tennis', 'Reacher', 'Pyramids', 'VisualPyramids', 'Walker', 'FoodCollector', 'VisualFoodCollector', 'StrikersVsGoalie', 'WormStaticTarget', 'WormDynamicTarget']"
-   ],
-   "execution_count": null,
-   "outputs": []
+    "List of available environments:\n",
+    "* Basic\n",
+    "* ThreeDBall\n",
+    "* ThreeDBallHard\n",
+    "* GridWorld\n",
+    "* Hallway\n",
+    "* VisualHallway\n",
+    "* CrawlerDynamicTarget\n",
+    "* CrawlerStaticTarget\n",
+    "* Bouncer\n",
+    "* SoccerTwos\n",
+    "* PushBlock\n",
+    "* VisualPushBlock\n",
+    "* WallJump\n",
+    "* Tennis\n",
+    "* Reacher\n",
+    "* Pyramids\n",
+    "* VisualPyramids\n",
+    "* Walker\n",
+    "* FoodCollector\n",
+    "* VisualFoodCollector\n",
+    "* StrikersVsGoalie\n",
+    "* WormStaticTarget\n",
+    "* WormDynamicTarget"
+   ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Start Environment with PettingZoo Wrapper"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
+   "execution_count": null,
    "metadata": {
     "id": "YSf-WhxbqtLw"
    },
+   "outputs": [],
    "source": [
     "# -----------------\n",
     "# This code is used to close an env that might not have been closed before\n",
@@ -189,29 +214,26 @@
     "# -----------------\n",
     "\n",
     "import numpy as np\n",
-    "from mlagents_envs.registry import default_registry\n",
-    "from pettingzoo_unity import UnityToPettingZooWrapper\n",
-    "\n",
-    "unity_env = default_registry[env_id].make()\n",
-    "env = UnityToPettingZooWrapper(unity_env)"
-   ],
-   "execution_count": null,
-   "outputs": []
+    "from pettingzoo_unity.envs import StrikersVsGoalie # import unity environment\n",
+    "env = StrikersVsGoalie.env()"
+   ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Stepping the environment\n",
     "\n",
     "Example of interacting with the environment in basic RL loop. It follows the same interface as described in [PettingZoo API page](https://www.pettingzoo.ml/api)."
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
+   "execution_count": null,
    "metadata": {
     "id": "dhtl0mpeqxYi"
    },
+   "outputs": [],
    "source": [
     "num_cycles = 10\n",
     "\n",
@@ -225,18 +247,16 @@
     "    else:\n",
     "        action = env.action_spaces[agent].sample() # randomly choose an action for example\n",
     "    env.step(action)"
-   ],
-   "execution_count": null,
-   "outputs": []
+   ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Additional Environment API\n",
     "\n",
     "All the API described in the `Additional Environment API` section in the [PettingZoo API page](https://www.pettingzoo.ml/api) are all supported. A few examples are shown below."
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
@@ -281,22 +301,59 @@
    ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Close the Environment to free the port it is using"
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+   ]
   },
   {
    "cell_type": "code",
+   "execution_count": null,
    "metadata": {
     "id": "a7KatdThq7OV"
    },
+   "outputs": [],
    "source": [
     "env.close()"
-   ],
-   "execution_count": null,
-   "outputs": []
+   ]
   }
- ]
+ ],
+ "metadata": {
+  "colab": {
+   "collapsed_sections": [],
+   "name": "Colab-UnityEnvironment-1-Run.ipynb",
+   "private_outputs": true,
+   "provenance": [],
+   "toc_visible": true
+  },
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.8"
+  },
+  "pycharm": {
+   "stem_cell": {
+    "cell_type": "raw",
+    "metadata": {
+     "collapsed": false
+    },
+    "source": []
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
 }

pettingzoo-unity/pettingzoo_unity/envs/__init__.py

@@ -42,7 +42,7 @@ def env(self, seed: Optional[int] = None, **kwargs):
 
 
 for env_id in default_registry:
-    env_id = env_id.replace("3DBall", "ThreeDBall")
+    env_id = env_id.replace("3", "Three")
     if not env_id.isidentifier():
         logger.warning(
             f"Environment id {env_id} can not be registered since it is"