Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc refined #122

Merged
merged 4 commits into from Sep 30, 2020
Merged

doc refined #122

merged 4 commits into from Sep 30, 2020

Conversation

Jinyu-W
Copy link
Collaborator

@Jinyu-W Jinyu-W commented Sep 29, 2020

No description provided.

chaosddp
chaosddp previously approved these changes Sep 29, 2020
@codecov-commenter
Copy link

codecov-commenter commented Sep 30, 2020

Codecov Report

Merging #122 into v0.1 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             v0.1     #122   +/-   ##
=======================================
  Coverage   72.36%   72.36%           
=======================================
  Files          87       87           
  Lines        4089     4089           
=======================================
  Hits         2959     2959           
  Misses       1130     1130           
Flag Coverage Δ
#unittests 72.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5b47455...2f2a6bb. Read the comment docs.

@chaosddp chaosddp self-requested a review September 30, 2020 02:42
@Jinyu-W Jinyu-W merged commit 38c0bc2 into v0.1 Sep 30, 2020
Jinyu-W added a commit that referenced this pull request Sep 30, 2020
* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

* Merge master to v0.1 (#127)

* V0.1 (#120)

* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

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>

* Create coverage.yml

* Update coverage.yml

* Update coverage.yml

* Add linters folder to hold flake8 linter conf to support 'Supor-linter' (#125)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* Update flake8 lint rule to ignore cli banner in maro.py (#126)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* update lint conf to ignore cli banner issue

Co-authored-by: Arthur Jiang <ArthurSJiang@gmail.com>
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: 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>

* rm unused requirements, add coverage badge

* V0.1 apidoc (#124)

* apidoc context init

* blank line added

* remove rl.common

* Docstring of Logger & Exception refined

* add the stdout_level arg

* update api docs of maro.utils.utils (#106)

* update api doc of maro.utils.utils

* update api doc of maro.utils.utils

* update for comments

* docs: add docstrings for CliLogger (#107)

* docs: add docstrings for CliLogger

* fix: refine style

* fix: wrap code snippets

* fix: refine style

* update communication docstring (#103)

* update communication docstring

* update docstring for communication

* add some missing docstring and delete communication.util in apidoc

* resolve comments

* resolve comment v2

* APIDOC format refined

* APIDOC format refined

* Utils API DOC format refined

* refined RL toolkit docstrings (#113)

* refined docstrings

* refined rl toolkit docs

* refined rl toolkit docstrings

* added some details to some methods

* checked out some rst files from v0.1

* refined rl toolkit docs

* changed i.e. to e.g.

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* rl apidoc format refined

* refined communication docstring

* added more doctstrings in RL toolkit (#121)

* added more docstrings

* removed unwanted spaces

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* apidoc format refined

* simulator related docstr refine (#108)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* framebase, framenode, attribute

* nodebase, snapshot list

* event buffer

* abs be

* simulator utils

* event bind reader

* simulator random module

* simulator exceptions

* refine code style for citibike scenario, correct license issue

* code style for cim

* code style for event buffer

* code style for cim generator

* code style for data lib

* code style for frame

* correct flake8 lint issue

* correct lint issue for data lib, simulator

* add flake8 config

* correct lint issue

* add flake8 as dev dependency

* add on value change event handler

* upate comments

* refine docstr, add more for parts

* hello world

* add lines

* docstring refined

* code refined based on flake8

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>
Co-authored-by: zhanyu wang <pocket_2001@163.com>
Co-authored-by: Romic Huang <romic.kid@gmail.com>
Co-authored-by: kaiqli <59279714+kaiqli@users.noreply.github.com>
Co-authored-by: ysqyang <ysqyang@gmail.com>
Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
Co-authored-by: Chaos Yu <chaos.you@gmail.com>

* doc refined (#122)

* doc refined

* tailing space removed

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

Co-authored-by: Arthur Jiang <sjian@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>
Co-authored-by: Arthur Jiang <ArthurSJiang@gmail.com>
Co-authored-by: Romic Huang <romic.hlc@outlook.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>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
ArthurJiang added a commit that referenced this pull request Sep 30, 2020
* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

* Merge master to v0.1 (#127)

* V0.1 (#120)

* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

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>

* Create coverage.yml

* Update coverage.yml

* Update coverage.yml

* Add linters folder to hold flake8 linter conf to support 'Supor-linter' (#125)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* Update flake8 lint rule to ignore cli banner in maro.py (#126)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* update lint conf to ignore cli banner issue

Co-authored-by: Arthur Jiang <ArthurSJiang@gmail.com>
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: 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>

* rm unused requirements, add coverage badge

* V0.1 apidoc (#124)

* apidoc context init

* blank line added

* remove rl.common

* Docstring of Logger & Exception refined

* add the stdout_level arg

* update api docs of maro.utils.utils (#106)

* update api doc of maro.utils.utils

* update api doc of maro.utils.utils

* update for comments

* docs: add docstrings for CliLogger (#107)

* docs: add docstrings for CliLogger

* fix: refine style

* fix: wrap code snippets

* fix: refine style

* update communication docstring (#103)

* update communication docstring

* update docstring for communication

* add some missing docstring and delete communication.util in apidoc

* resolve comments

* resolve comment v2

* APIDOC format refined

* APIDOC format refined

* Utils API DOC format refined

* refined RL toolkit docstrings (#113)

* refined docstrings

* refined rl toolkit docs

* refined rl toolkit docstrings

* added some details to some methods

* checked out some rst files from v0.1

* refined rl toolkit docs

* changed i.e. to e.g.

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* rl apidoc format refined

* refined communication docstring

* added more doctstrings in RL toolkit (#121)

* added more docstrings

* removed unwanted spaces

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* apidoc format refined

* simulator related docstr refine (#108)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* framebase, framenode, attribute

* nodebase, snapshot list

* event buffer

* abs be

* simulator utils

* event bind reader

* simulator random module

* simulator exceptions

* refine code style for citibike scenario, correct license issue

* code style for cim

* code style for event buffer

* code style for cim generator

* code style for data lib

* code style for frame

* correct flake8 lint issue

* correct lint issue for data lib, simulator

* add flake8 config

* correct lint issue

* add flake8 as dev dependency

* add on value change event handler

* upate comments

* refine docstr, add more for parts

* hello world

* add lines

* docstring refined

* code refined based on flake8

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>
Co-authored-by: zhanyu wang <pocket_2001@163.com>
Co-authored-by: Romic Huang <romic.kid@gmail.com>
Co-authored-by: kaiqli <59279714+kaiqli@users.noreply.github.com>
Co-authored-by: ysqyang <ysqyang@gmail.com>
Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
Co-authored-by: Chaos Yu <chaos.you@gmail.com>

* doc refined (#122)

* doc refined

* tailing space removed

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* update version

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>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
ArthurJiang added a commit that referenced this pull request Oct 1, 2020
* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

* Merge master to v0.1 (#127)

* V0.1 (#120)

* 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

* fixed a key error in K-step shaper for CIM (#80)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 baseline results (#81)

* adding baseline results

* updated ecr results

* updated cim baseline results

* added citibike no_action results

* restored cim/hello.py

* cim result update

* citibike result update

* added missing files

* fixed a bug

* updated citibike random repositioning results

* completed baseline results

* update citi bike results

* format update

* remove runner files

Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* duplicated notebook removed

* update distributed example (#69)

* update distributed example

* add config.py for distributed mode examples

* add new_line in config.py

* repalce title with caps

* add test and build badge (#76)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* V0.1 k step key error fix (#84)

* fixed a key error in K-step shaper for CIM

* fixed key error in k-step shaper in dist_actor

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* fixed unpicklable bug in k step shaper (#87)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* Update and rename unittests.yml to test.yml

* code block format update

* removed sentence above title (#90)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* cim results update * 20 (#88)

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* V0.1 import bug fix in example (#86)

* fixed a key error in K-step shaper for CIM

* fixing import bugs

* removed a blank line and an unwanted import

* added __init__ in components and changed import accordingly

* added . before components

* removed . before components

* moved dist_actor and dist_learner out of components

* fixed a bug

* fixed import formatting

* fixed import formatting

* removed config read from single_process_launcher

* restored absolute path for running dist_actor and dist_learner

* fixed a bug

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* updated citibike resposition number column

* fixed table formatiing

* Update setup.py

* fix pypi meta

* refine doc string

* fix classifier

* fix pypi homepage

* update badge

* V0.1 bug cli (#71)

* fix: previous fix cannot solve this problem

* fix: loadBalancerSku is required in new azure-cli deployment

* enable weather data (#96)

* 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

* add noaa weather source

* fix weather reset and weather comment

* add comment for weather data url

* some format update

* add badges for scenarios and platforms (#100)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* update badges

* update static badges

* fix

* changed default logging levels (#98)

* changed default logging levels

* changed logger level back to DEBUG in Logger class

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* V0.1 citibike notebook bug (#94)

* rewrote citibike nb using greedy agent

* checked out missing files from v0.1

* refined notebooks

* added output in greedy_policy.ipynb

* added output

* added output to cim nb

* refined nb

* renamed GreedyAgent to GreedyPolicy

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* update github workflow, add quality action (#111)

* update github workflow, add quality action

* update quality parameter

* update quality

* update quality parameter

Co-authored-by: Arthur Jiang <sjian@microsoft.com>

* delete proxy useless parameter (#114)

* add badge for quality

* add flake8 config and requirement (#117)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* add badges for scenario and platform

* add flake8 config and requirement

* add a new line to end

* fix readthedoc build issue

* update doc

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>

* Create coverage.yml

* Update coverage.yml

* Update coverage.yml

* Add linters folder to hold flake8 linter conf to support 'Supor-linter' (#125)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* Update flake8 lint rule to ignore cli banner in maro.py (#126)

* update lint workflow

* fix workflow issue

* Update lint.yml

* Create tox.ini

* Update lint.yml

* Update lint.yml

* Update tox.ini

* Update lint.yml

* Delete tox.ini from root folder, move it to .github/linters

* Update CONTRIBUTING.md

* add more comments

* update lint conf to ignore cli banner issue

Co-authored-by: Arthur Jiang <ArthurSJiang@gmail.com>
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: 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>

* rm unused requirements, add coverage badge

* V0.1 apidoc (#124)

* apidoc context init

* blank line added

* remove rl.common

* Docstring of Logger & Exception refined

* add the stdout_level arg

* update api docs of maro.utils.utils (#106)

* update api doc of maro.utils.utils

* update api doc of maro.utils.utils

* update for comments

* docs: add docstrings for CliLogger (#107)

* docs: add docstrings for CliLogger

* fix: refine style

* fix: wrap code snippets

* fix: refine style

* update communication docstring (#103)

* update communication docstring

* update docstring for communication

* add some missing docstring and delete communication.util in apidoc

* resolve comments

* resolve comment v2

* APIDOC format refined

* APIDOC format refined

* Utils API DOC format refined

* refined RL toolkit docstrings (#113)

* refined docstrings

* refined rl toolkit docs

* refined rl toolkit docstrings

* added some details to some methods

* checked out some rst files from v0.1

* refined rl toolkit docs

* changed i.e. to e.g.

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* rl apidoc format refined

* refined communication docstring

* added more doctstrings in RL toolkit (#121)

* added more docstrings

* removed unwanted spaces

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* apidoc format refined

* simulator related docstr refine (#108)

* 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

* add badge

* change unittest to test

* add docker image badge

* remove unexist folders

* ignore badges, ignore examples as module

* remove __init__ file from examples

* framebase, framenode, attribute

* nodebase, snapshot list

* event buffer

* abs be

* simulator utils

* event bind reader

* simulator random module

* simulator exceptions

* refine code style for citibike scenario, correct license issue

* code style for cim

* code style for event buffer

* code style for cim generator

* code style for data lib

* code style for frame

* correct flake8 lint issue

* correct lint issue for data lib, simulator

* add flake8 config

* correct lint issue

* add flake8 as dev dependency

* add on value change event handler

* upate comments

* refine docstr, add more for parts

* hello world

* add lines

* docstring refined

* code refined based on flake8

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>
Co-authored-by: zhanyu wang <pocket_2001@163.com>
Co-authored-by: Romic Huang <romic.kid@gmail.com>
Co-authored-by: kaiqli <59279714+kaiqli@users.noreply.github.com>
Co-authored-by: ysqyang <ysqyang@gmail.com>
Co-authored-by: ysqyang <v-yangqi@microsoft.com>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
Co-authored-by: Chaos Yu <chaos.you@gmail.com>

* doc refined (#122)

* doc refined

* tailing space removed

Co-authored-by: Jinyu Wang <Wang.Jinyu@microsoft.com>

* update version

* fixed typo in citibike nb (#137)

Co-authored-by: ysqyang <v-yangqi@microsoft.com>

* refine readme

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>
Co-authored-by: kaiqli <v-kaiqli@microsoft.com>
@ArthurJiang ArthurJiang deleted the v0.1_doc_refined branch October 13, 2020 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants