V0.1 (#79)

* setup v0.1 * rm \n in comments * QuickStart added for docs.scenarios * experiment result of citi bike update to 1-month version * V0.1 issues installation (#38) * replace pycurl to urllib * rm pycurl in test requirements * fix installation issue, update readme, speed up citibike Co-authored-by: Arthur Jiang <sjian@microsoft.com> * notebook link added for scenarios * fix: add missing licenses, refine long lines (#36) * scenario notebook update (#39) Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> * scenario doc modified according to comments * doc correction * scenario doc modified according to comments * remove examples * rl toolkit refactoring (#42) * rl toolkit refactoring * rename citi_bike * add new line Co-authored-by: Arthur Jiang <sjian@microsoft.com> * fix issue during building playground images (#44) * citibike doc modified according to comments * citibike doc update * scenario experiment result table changed * annotate the empty experiment results * merge master into v0.1 for later merging (#47) * setup v0.1 (#34) Co-authored-by: Arthur Jiang <sjian@microsoft.com> * fix pycurl install issue (#35) Co-authored-by: Arthur Jiang <ArthurSJiang@gmail.com> Co-authored-by: Arthur Jiang <sjian@microsoft.com> * refine readme * fix: recursive copy instead of plain copy (#45) * update maro overall image * typo * add key components * fix deployment issue in multi envs (#49) * typo * refine introduction * fix typo * fix readme * refine readme * refine readme * update readme docs link * fix ~/.maro not exist issue in build (#52) * fix deployment issue in multi envs * fix typo * fix ~/.maro not exist issue in build * skip deploy when build * update for comments * refine logo * fix toctree * fix & feat: invalid filename & maro grass status (#51) * fix: change invalid filename to valid * feat: add maro grass status * refine * refine * V0.1 test store update (#58) * updateed test_store.py * fixed unpicklable store bug Co-authored-by: ysqyang <v-yangqi@microsoft.com> * rename ecr 2 cim (#62) * correct dependencies * rename ecr to cim for hello, scenario, datalib and tests * remove unused dependency for build * add a new line at the end * a'd * V0.1 rename to cim in example (#63) * renamed ecr to cim and removed unwanted files * renamed ecr to cim in other places * fixed PR conflicts * merged with v0.1 Co-authored-by: ysqyang <v-yangqi@microsoft.com> * fix ut issue under window, now all runpass (#64) * correct dependencies * rename ecr to cim for hello, scenario, datalib and tests * install torch first before test dependencies * missing ecr 2 cim * V0.1 ecr rename (#65) * rename ecr to cim in docs * ecr renamed for notebooks * OOCL removed * rename ecr to cim * title level modified * notebook update Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> * temporarily disable weather, fix station id issue (#66) * fix deployment issue in multi envs * fix typo * fix ~/.maro not exist issue in build * skip deploy when build * update for comments * temporarily disable weather info * replace ecr with cim in setup.py * replace ecr in manifest * remove weather check when read data * fix station id issue * fix format * add TODO in comments * V0.1 ecr rename (#67) * rename ecr to cim in docs * ecr renamed for notebooks * OOCL removed * rename ecr to cim * title level modified * notebook update * topo renamed Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> * change the keys in metrics (#68) * correct dependencies * rename ecr to cim for hello, scenario, datalib and tests * install torch first before test dependencies * missing ecr 2 cim * rename metrics keys * remove transfer cost factor * rename cost to number * update setup * Update build_wheel.yml * Update build_wheel.yml * Update build_wheel.yml * Update build_wheel.yml * rm install from PyPi * V0.1 cim nb (#70) * added cim nb * fixed bugs in nb * fixed bugs in nb * fixed a bug in nb Co-authored-by: ysqyang <v-yangqi@microsoft.com> * the font size of doc diagrams is enlarged (#73) * the font size of doc diagrams is enlarged * disable APIDOC Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> * str() and repr() of DecisionEvent and Action added; notebook output updated (#74) Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> * Update deploy_gh_pages.yml * fix docker build * V0.1 feature docker ci (#77) * Update deploy_docker_image.yml * Update deploy_docker_image.yml * Update deploy_docker_image.yml * Update deploy_docker_image.yml * refine * add contributing Co-authored-by: Arthur Jiang <sjian@microsoft.com> * update playground docs Co-authored-by: Arthur Jiang <sjian@microsoft.com> Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com> Co-authored-by: Romic Huang <romic.hlc@outlook.com> Co-authored-by: Jinyu-W <53509467+Jinyu-W@users.noreply.github.com> Co-authored-by: kaiqli <59279714+kaiqli@users.noreply.github.com> Co-authored-by: Chaos Yu <chaos.you@gmail.com> Co-authored-by: Romic Huang <romic.kid@gmail.com> Co-authored-by: zhanyu wang <pocket_2001@163.com> Co-authored-by: ysqyang <ysqyang@gmail.com> Co-authored-by: ysqyang <v-yangqi@microsoft.com>
microsoft · Sep 23, 2020 · 1b8a1c8 · 1b8a1c8
1 parent e5f879d
commit 1b8a1c8
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ of user-defined functions for message auto-handling, cluster provision, and job
 
   - Windows
 
-    ```ps
+    ```powershell
     # If your environment is not clean, create a virtual environment firstly.
     python -m venv maro_venv
     .\maro_venv\Scripts\activate
@@ -71,7 +71,7 @@ of user-defined functions for message auto-handling, cluster provision, and job
 
   - Windows
 
-    ```ps
+    ```powershell
     # Install MARO from source.
     .\scripts\install_maro.bat
     ```
@@ -94,16 +94,42 @@ print(f"environment metrics: {env.metrics}")
 
 ## Run Playground
 
-```sh
-# Build playground image
-docker build -f ./docker_files/cpu.play.df . -t maro/playground:cpu
+- Pull from [Docker Hub](https://hub.docker.com/repository/registry-1.docker.io/arthursjiang/maro/tags?page=1)
 
-# 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
-```
+  ```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
+  ```
+
+- Build from source
+  - Mac OS / Linux
+
+    ```sh
+    # Build playground image.
+    bash ./scripts/build_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 maro/playground:cpu
+    ```
+
+  - Windows
+
+    ```powershell
+    # Build playground image.
+    .\scripts\build_playground.bat
+
+    # 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
+    ```
 
 ## Contributing
 

diff --git a/docs/source/installation/playground.md b/docs/source/installation/playground.md
@@ -1,23 +1,42 @@
 # Playground Docker Image
 
-## Pull from `Docker Hub`
+## Pull from [Docker Hub](https://hub.docker.com/repository/registry-1.docker.io/arthursjiang/maro/tags?page=1)
 
-```sh
-# TODO: have not pushed to Docker Hub
-```
+    ```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
+    ```
 
 ## Run from Source
 
-```sh
-# Build playground image
-docker build -f ./docker_files/cpu.play.df . -t maro/playground:cpu
+- Mac OS / Linux
 
-# 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
-```
+  ```sh
+  # Build playground image.
+  bash ./scripts/build_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 maro/playground:cpu
+  ```
+
+- Windows
+
+  ```powershell
+  # Build playground image.
+  .\scripts\build_playground.bat
+
+  # 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
+  ```
 
 ## Major Services in Playground
 

diff --git a/playground.md b/playground.md
@@ -15,6 +15,4 @@ Playground provides a standalone MARO running environment, it also includes exam
 |-------------------|--------------------------------------------|
 | `examples`        | Showcases of predefined scenarios.         |
 | `notebooks`       | Quick-start tutorial.                      |
-*(Others can be ignored, which aren't mentioned in the table.)*
-
-## Data CLI (TODO)
+*(Others can be ignored, which aren't mentioned in the table.)*