update docker hub init (#367)

* update docker hub init

* replace personal account with maro-team

* update hello files for CIM

* update docker repository name

* update docker file name

* fix bugs in notebook, rectify docs

* fix doc build issue

* remove docs from playground; fix citibike lp example Event issue

* update the exampel for vector env

* update vector env example

* update README due to PR comments

* add link to playground above MARO installation in README

* fix some typos

Co-authored-by: Jinyu Wang <[email protected]>

Author: Jinyu-W

.github/ISSUE_TEMPLATE/---bug-report.md

@@ -38,7 +38,7 @@ Steps to reproduce the behavior:
 - How you installed MARO (`pip`, `source`):
 - OS (`Linux`, `Windows`, `macOS`):
 - Python version (`3.6`, `3.7`):
-- Docker image (e.g., arthursjiang/maro:cpu[5f36ed]):
+- Docker image (e.g., maro2020/maro:latest):
 - CPU/GPU:
 - Any other relevant information:
 

.github/workflows/deploy_docker_image.yml

@@ -30,7 +30,7 @@ jobs:
       run: |
         pip install -r ./maro/requirements.build.txt
         cython ./maro/backends/backend.pyx ./maro/backends/np_backend.pyx ./maro/backends/raw_backend.pyx ./maro/backends/frame.pyx --cplus -3 -E NODES_MEMORY_LAYOUT=ONE_BLOCK -X embedsignature=True
-        cat ./maro/__misc__.py | grep __version__ | egrep -o [0-9].[0-9].[0-9,a-z]+ | { read version; docker build -f ./docker_files/cpu.play.df . -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:cpu -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:latest -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:cpu-$version; }
+        cat ./maro/__misc__.py | grep __version__ | egrep -o [0-9].[0-9].[0-9,a-z]+ | { read version; docker build -f ./docker_files/cpu.playground.df . -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:cpu -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:latest -t ${{ secrets.DOCKER_HUB_USERNAME }}/maro:cpu-$version; }
 
     - name: Login docker hub
       run: |

README.md

@@ -2,13 +2,13 @@
 [![Platform](https://raw.githubusercontent.com/microsoft/maro/master/docs/source/images/badges/platform.svg)](https://pypi.org/project/pymaro/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/pymaro.svg?logo=python&logoColor=white)](https://pypi.org/project/pymaro/#files)
 [![Code Size](https://img.shields.io/github/languages/code-size/microsoft/maro)](https://github.com/microsoft/maro)
-[![Docker Size](https://img.shields.io/docker/image-size/arthursjiang/maro)](https://hub.docker.com/repository/docker/arthursjiang/maro/tags?page=1)
+[![Docker Size](https://img.shields.io/docker/image-size/maro2020/maro)](https://hub.docker.com/repository/docker/maro2020/maro/tags?page=1)
 [![Issues](https://img.shields.io/github/issues/microsoft/maro)](https://github.com/microsoft/maro/issues)
 [![Pull Requests](https://img.shields.io/github/issues-pr/microsoft/maro)](https://github.com/microsoft/maro/pulls)
 [![Dependencies](https://img.shields.io/librariesio/github/microsoft/maro)](https://libraries.io/pypi/pymaro)
 [![test](https://github.com/microsoft/maro/workflows/test/badge.svg)](https://github.com/microsoft/maro/actions?query=workflow%3Atest)
 [![build](https://github.com/microsoft/maro/workflows/build/badge.svg)](https://github.com/microsoft/maro/actions?query=workflow%3Abuild)
-[![docker](https://github.com/microsoft/maro/workflows/docker/badge.svg)](https://hub.docker.com/repository/docker/arthursjiang/maro)
+[![docker](https://github.com/microsoft/maro/workflows/docker/badge.svg)](https://hub.docker.com/repository/docker/maro2020/maro)
 [![docs](https://readthedocs.org/projects/maro/badge/?version=latest)](https://maro.readthedocs.io/)
 [![PypI Versions](https://img.shields.io/pypi/v/pymaro)](https://pypi.org/project/pymaro/#files)
 [![Wheel](https://img.shields.io/pypi/wheel/pymaro)](https://pypi.org/project/pymaro/#files)
@@ -23,8 +23,8 @@
 [![Lint](https://github.com/microsoft/maro/workflows/lint/badge.svg)](https://github.com/microsoft/maro/actions?query=workflow%3Alint)
 [![Coverage](https://img.shields.io/codecov/c/github/microsoft/maro)](https://codecov.io/gh/microsoft/maro)
 [![Downloads](https://img.shields.io/pypi/dm/pymaro)](https://pypi.org/project/pymaro/#files)
-[![Docker Pulls](https://img.shields.io/docker/pulls/arthursjiang/maro)](https://hub.docker.com/repository/docker/arthursjiang/maro)
-[![Play with MARO](https://raw.githubusercontent.com/microsoft/maro/master/docs/source/images/badges/play_with_maro.svg)](https://hub.docker.com/r/arthursjiang/maro)
+[![Docker Pulls](https://img.shields.io/docker/pulls/maro2020/maro)](https://hub.docker.com/repository/docker/maro2020/maro)
+[![Play with MARO](https://raw.githubusercontent.com/microsoft/maro/master/docs/source/images/badges/play_with_maro.svg)](https://hub.docker.com/r/maro2020/maro)
 
 # [![MARO LOGO](./docs/source/images/logo.svg)](https://maro.readthedocs.io/en/latest/)
 
@@ -58,6 +58,8 @@ of user-defined functions for message auto-handling, cluster provision, and job
 | `examples`  | Showcase of MARO.                                                                                 |
 | `notebooks` | MARO quick-start notebooks.                                                                       |
 
+*Try [MARO playground](#run-playground) to have a quick experience.*
+
 ## Install MARO from [PyPI](https://pypi.org/project/pymaro/#files)
 
 *Notes: The CLI commands (including the visualization tool) are not included in pymaro package. To enable these support, you need to install from source.*
@@ -185,14 +187,13 @@ maro inspector dashboard --source_path ./dump_data/YOUR_SNAPSHOT_DUMP_FOLDER
 
 ## Run Playground
 
-- Pull from [Docker Hub](https://hub.docker.com/repository/registry-1.docker.io/arthursjiang/maro/tags?page=1)
+- Pull from [Docker Hub](https://hub.docker.com/r/maro2020/playground)
 
   ```sh
   # Run playground container.
   # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-  # Local host docs -> http://127.0.0.1:40010
-  # Jupyter lab with maro -> http://127.0.0.1:40011
-  docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 arthursjiang/maro:cpu
+  # Jupyter lab with maro -> http://127.0.0.1:40010
+  docker run -p 40009:40009 -p 40010:40010 maro2020/playground
   ```
 
 - Build from source
@@ -204,9 +205,8 @@ maro inspector dashboard --source_path ./dump_data/YOUR_SNAPSHOT_DUMP_FOLDER
 
     # Run playground container.
     # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-    # Local host docs -> http://127.0.0.1:40010
-    # Jupyter lab with maro -> http://127.0.0.1:40011
-    docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 maro/playground:cpu
+    # Jupyter lab with maro -> http://127.0.0.1:40010
+    docker run -p 40009:40009 -p 40010:40010 maro2020/playground
     ```
 
   - Windows
@@ -217,9 +217,8 @@ maro inspector dashboard --source_path ./dump_data/YOUR_SNAPSHOT_DUMP_FOLDER
 
     # Run playground container.
     # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-    # Local host docs -> http://127.0.0.1:40010
-    # Jupyter lab with maro -> http://127.0.0.1:40011
-    docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 maro/playground:cpu
+    # Jupyter lab with maro -> http://127.0.0.1:40010
+    docker run -p 40009:40009 -p 40010:40010 maro2020/playground
     ```
 
 ## Contributing

docker_files/cpu.play.df docker_files/cpu.playground.df

@@ -1,20 +1,8 @@
-FROM python:3.6
+FROM python:3.7
 
 WORKDIR /maro_playground
 
-# Setup notebook
-ADD ./notebooks ./notebooks
-RUN /usr/local/bin/python -m pip install --upgrade pip
-RUN pip install -r ./notebooks/requirements.nb.txt
-RUN jupyter contrib nbextension install --system
-RUN jt -t onedork -fs 95 -altp -tfs 11 -nfs 115 -cellw 88% -T
-
-
-# Install redis
-RUN wget http://download.redis.io/releases/redis-6.0.6.tar.gz; tar xzf redis-6.0.6.tar.gz; cd redis-6.0.6; make
-RUN rm redis-6.0.6.tar.gz
-
-# Install others
+# Install zsh and other packages for the terminal usage
 RUN apt-get -o Acquire::Check-Valid-Until=false -o Acquire::Check-Date=false update
 RUN apt-get install -y zsh
 RUN apt-get install -y htop
@@ -23,42 +11,36 @@ RUN wget https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -
 RUN chsh -s `which zsh` && wget https://raw.githubusercontent.com/ArthurJiang/config/master/.zshrc -O ~/.zshrc
 RUN apt-get install -y npm
 RUN rm -rf /var/lib/apt/lists/*
+
+# Install redis
+RUN wget http://download.redis.io/releases/redis-6.0.6.tar.gz; tar xzf redis-6.0.6.tar.gz; cd redis-6.0.6; make
+RUN rm redis-6.0.6.tar.gz
 RUN npm install -g redis-commander
 
+# Setup notebook
+ADD ./notebooks ./notebooks
+RUN /usr/local/bin/python -m pip install --upgrade pip
+RUN pip install -r ./notebooks/requirements.nb.txt
+RUN jupyter contrib nbextension install --system
+RUN jt -t onedork -fs 95 -altp -tfs 11 -nfs 115 -cellw 88% -T
+RUN rm ./notebooks/*.txt
+RUN rm ./notebooks/*.sh
+
 # Add examples
 ADD ./examples ./examples
+ADD ./examples/requirements.ex.txt ./examples/requirements.ex.txt
+RUN pip install -r ./examples/requirements.ex.txt
+RUN rm ./examples/requirements.ex.txt
 
-# Add local docs
-ADD ./docs ./docs
-ADD ./maro ./maro
-ADD setup.py setup.py
-ADD ./scripts ./scripts
-RUN bash scripts/install_maro.sh
-RUN pip install -U -r ./docs/requirements.docs.txt
-RUN cd docs; make html
-RUN rm -rf ./maro
-RUN rm setup.py
-RUN rm -rf ./scripts
+# Install MARO
+RUN pip install pymaro
+ENV PYTHONPATH ./
 
 # Add run cmd
 ADD ./scripts/run_playground.sh ./run.sh
 
-# Add readme
+# Add README
 ADD ./playground.md ./README.md
 
-# Clean
-RUN rm ./notebooks/*.txt
-RUN rm ./notebooks/*.sh
-RUN rm -r ./docs/source
-RUN rm ./docs/make.bat
-RUN rm ./docs/Makefile
-RUN rm ./docs/README.md
-RUN rm ./docs/requirements.docs.txt
-RUN rm -rf ./build
-RUN rm -rf ./pymaro.egg-info
-
-# Install maro
-RUN pip install pymaro
-
 # Start service
 CMD ["/bin/bash", "./run.sh"]

docs/source/examples/greedy_policy_citi_bike.rst

@@ -76,4 +76,4 @@ This environment is driven by `real trip history data <https://s3.amazonaws.com/
 
 .. note::
 
-  All related code snippets are supported in `maro playground <https://hub.docker.com/r/arthursjiang/maro>`_.
+  All related code snippets are supported in `maro playground <https://hub.docker.com/r/maro2020/playground>`_.

docs/source/examples/multi_agent_dqn_cim.rst

@@ -19,15 +19,15 @@ in the roll-out loop. In this example,
     to or unloaded from the vessel) to action objects that can be executed by the environment.
   * ``get_offline_reward`` computes the reward of a given action as a linear combination of fulfillment and
     shortage within a future time frame.
-  * ``on_finish`` processes a complete trajectory into data that can be used directly by the learning agents. 
+  * ``on_finish`` processes a complete trajectory into data that can be used directly by the learning agents.
 
 
 .. code-block:: python
     class CIMTrajectoryForDQN(Trajectory):
         def __init__(
             self, env, *, port_attributes, vessel_attributes, action_space, look_back, max_ports_downstream,
             reward_time_window, fulfillment_factor, shortage_factor, time_decay,
-            finite_vessel_space=True, has_early_discharge=True 
+            finite_vessel_space=True, has_early_discharge=True
         ):
             super().__init__(env)
             self.port_attributes = port_attributes
@@ -113,7 +113,7 @@ Agent
 
 The out-of-the-box DQN is used as our agent.
 
-.. code-block:: python    
+.. code-block:: python
     agent_config = {
         "model": ...,
         "optimization": ...,
@@ -149,7 +149,7 @@ The learner's side requires a concrete learner class that inherits from ``AbsLea
 method which contains the main training loop. Here the implementation is similar to the single-threaded version
 except that the ``collect`` method is used to obtain roll-out data from the actors (since the roll-out executors
 are located on the actors' side). The agents created here are where training occurs and hence always contains the
-latest policies. 
+latest policies.
 
 .. code-block:: python
     def cim_dqn_learner():
@@ -165,4 +165,4 @@ latest policies.
 
 .. note::
 
-  All related code snippets are supported in `maro playground <https://hub.docker.com/r/arthursjiang/maro>`_.
+  All related code snippets are supported in `maro playground <https://hub.docker.com/r/maro2020/playground>`_.

docs/source/index.rst

@@ -32,45 +32,35 @@ Quick Start
 .. code-block:: python
 
     from maro.simulator import Env
-    from maro.simulator.scenarios.cim.common import Action
+    from maro.simulator.scenarios.cim.common import Action, ActionType, DecisionEvent
 
-    # Initialize an environment with a specific scenario, related topology.
-    # In Container Inventory Management, 1 tick means 1 day, here durations=100 means a length of 100 days
+    from random import randint
+
+    # Initialize an Env for cim scenario
     env = Env(scenario="cim", topology="toy.5p_ssddd_l0.0", start_tick=0, durations=100)
 
-    # Query environment summary, which includes business instances, intra-instance attributes, etc.
-    print(env.summary)
-
-    for ep in range(2):
-        # Gym-like step function.
-        metrics, decision_event, is_done = env.step(None)
-
-        while not is_done:
-            past_week_ticks = [
-                x for x in range(decision_event.tick - 7, decision_event.tick)
-            ]
-            decision_port_idx = decision_event.port_idx
-            intr_port_infos = ["booking", "empty", "shortage"]
-
-            # Query the snapshot list of the environment to get the information of
-            # the booking, empty container inventory, shortage of the decision port in the past week.
-            past_week_info = env.snapshot_list["ports"][
-                past_week_ticks : decision_port_idx : intr_port_infos
-            ]
-
-            dummy_action = Action(
-                vessel_idx=decision_event.vessel_idx,
-                port_idx=decision_event.port_idx,
-                quantity=0
-            )
-
-            # Drive environment with dummy action (no repositioning).
-            metrics, decision_event, is_done = env.step(dummy_action)
-
-        # Query environment business metrics at the end of an episode,
-        # it is your optimized object (usually includes multi-target).
-        print(f"ep: {ep}, environment metrics: {env.metrics}")
-        env.reset()
+    metrics: object = None
+    decision_event: DecisionEvent = None
+    is_done: bool = False
+    action: Action = None
+
+    # Start the env with a None Action
+    metrics, decision_event, is_done = env.step(None)
+
+    while not is_done:
+        # Generate a random Action according to the action_scope in DecisionEvent
+        action_scope = decision_event.action_scope
+        to_discharge = action_scope.discharge > 0 and randint(0, 1) > 0
+
+        action = Action(
+            decision_event.vessel_idx,
+            decision_event.port_idx,
+            randint(0, action_scope.discharge if to_discharge else action_scope.load),
+            ActionType.DISCHARGE if to_discharge else ActionType.LOAD
+        )
+
+        # Respond the environment with the generated Action
+        metrics, decision_event, is_done = env.step(action)
 
 Contents
 ----------

docs/source/installation/playground.rst

@@ -2,16 +2,15 @@
 Playground Docker Image
 =======================
 
-Pull from `Docker Hub <https://hub.docker.com/repository/registry-1.docker.io/arthursjiang/maro/tags?page=1>`_
+Pull from `Docker Hub <https://hub.docker.com/repository/registry-1.docker.io/maro2020/playground/tags?page=1>`_
 ------------------------------------------------------------------------------------------------------------------
 
 .. code-block:: sh
 
    # Run playground container.
    # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-   # Local host docs -> http://127.0.0.1:40010
-   # Jupyter lab with maro -> http://127.0.0.1:40011
-   docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 arthursjiang/maro:cpu
+   # Jupyter lab with maro -> http://127.0.0.1:40010
+   docker run -p 40009:40009 -p 40010:40010 maro2020/playground
 
 Run from Source
 ---------------
@@ -25,9 +24,8 @@ Run from Source
 
      # Run playground container.
      # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-     # Local host docs -> http://127.0.0.1:40010
-     # Jupyter lab with maro -> http://127.0.0.1:40011
-     docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 maro/playground:cpu
+     # Jupyter lab with maro -> http://127.0.0.1:40010
+     docker run -p 40009:40009 -p 40010:40010 maro2020/playground
 
 * Windows
 
@@ -38,9 +36,8 @@ Run from Source
 
      # Run playground container.
      # Redis commander (GUI for redis) -> http://127.0.0.1:40009
-     # Local host docs -> http://127.0.0.1:40010
-     # Jupyter lab with maro -> http://127.0.0.1:40011
-     docker run -p 40009:40009 -p 40010:40010 -p 40011:40011 maro/playground:cpu
+     # Jupyter lab with maro -> http://127.0.0.1:40010
+     docker run -p 40009:40009 -p 40010:40010 maro2020/playground
 
 Major Services in Playground
 ----------------------------
@@ -54,15 +51,12 @@ Major Services in Playground
    * - ``Redis Commander``
      - Redis web GUI.
      - http://127.0.0.1:40009
-   * - ``Read the Docs``
-     - Local host docs.
-     - http://127.0.0.1:40010
    * - ``Jupyter Lab``
      - Jupyter lab with MARO environment, examples, notebooks.
-     - http://127.0.0.1:40011
+     - http://127.0.0.1:40010
 
 
-*(If you use other port mapping, remember to change the port number.)*
+*(Remember to change ports if you use different ports mapping.)*
 
 Major Materials in Root Folder
 ------------------------------
@@ -78,4 +72,4 @@ Major Materials in Root Folder
      - Quick-start tutorial.
 
 
-*(Those not mentioned in the table can be ignored.)*
+*(The ones not mentioned in this table can be ignored.)*