Add docstrings and comments

Author: maryamhonari

pettingzoo-unity/Colab_PettingZoo.ipynb

@@ -1,33 +1,4 @@
 {
- "nbformat": 4,
- "nbformat_minor": 0,
- "metadata": {
-  "colab": {
-   "name": "Colab-PettingZoo-Unity.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",
@@ -45,32 +16,9 @@
   },
   {
    "cell_type": "code",
-   "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"
-    }
-   ],
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
    "source": [
     "#@title Install Rendering Dependencies { display-mode: \"form\" }\n",
     "#@markdown (You only need to run this code when using Colab's hosted runtime)\n",
@@ -156,17 +104,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ml-agents already installed\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "try:\n",
     "  import mlagents\n",

pettingzoo-unity/pettingzoo_unity/envs/__init__.py

@@ -15,18 +15,25 @@
 logging_util.set_log_level(logging_util.WARNING)
 
 
-class petting_zoo_env:
-    def __init__(self, env_id):
+class PettingZooEnv:
+    def __init__(self, env_id: str) -> None:
         self.env_id = env_id
 
-    def env(self, seed: Optional[int] = None, **kwargs):
+    def env(self, seed: Optional[int] = None, **kwargs) -> UnityToPettingZooWrapper:
+        """
+        Creates the environment with env_id from unity's default_registry and wraps it in a UnityToPettingZooWrapper
+        :param seed: The seed for the action spaces of the agents.
+        :param kwargs: Any argument accepted by `UnityEnvironment`class except file_name
+        """
+        # If not side_channels specified, add the followings
         if "side_channels" not in kwargs:
             kwargs["side_channels"] = [
                 EngineConfigurationChannel(),
                 EnvironmentParametersChannel(),
                 StatsSideChannel(),
             ]
         _env = None
+        # If no base port argument is provided, try ports starting at 6000 until one is free
         if "base_port" not in kwargs:
             port = 6000
             while _env is None:
@@ -41,12 +48,13 @@ def env(self, seed: Optional[int] = None, **kwargs):
         return UnityToPettingZooWrapper(_env, seed)
 
 
-for env_id in default_registry:
-    env_id = env_id.replace("3", "Three")
-    if not env_id.isidentifier():
+# Register each environment in default_registry as a PettingZooEnv
+for key in default_registry:
+    key = key.replace("3", "Three")
+    if not key.isidentifier():
         logger.warning(
-            f"Environment id {env_id} can not be registered since it is"
+            f"Environment id {key} can not be registered since it is"
             f"not a valid identifier name."
         )
         continue
-    locals()[env_id] = petting_zoo_env(env_id)
+    locals()[key] = PettingZooEnv(key)