Skip to content

Commit

Permalink
merge V0.1 into master: doc + apidoc (#132)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
12 people committed Sep 30, 2020
1 parent b7e52f4 commit 702e3cd
Show file tree
Hide file tree
Showing 147 changed files with 3,715 additions and 2,707 deletions.
8 changes: 4 additions & 4 deletions .github/linters/tox.ini
@@ -1,13 +1,13 @@
[flake8]
ignore =
ignore =
# module level import not at top of file
E402,
# line break after binary operator
W504,
# line break before binary operator
W503
exclude =

exclude =
.git,
__pycache__,
docs,
Expand All @@ -23,7 +23,7 @@ exclude =

max-line-length = 120

per-file-ignores =
per-file-ignores =
# import not used: ignore in __init__.py files
__init__.py:F401
# igore invalid escape sequence in cli main script to show banner
Expand Down
13 changes: 0 additions & 13 deletions docs/source/apidoc/maro.backends.rst

This file was deleted.

12 changes: 0 additions & 12 deletions docs/source/apidoc/maro.datalib.rst

This file was deleted.

12 changes: 0 additions & 12 deletions docs/source/apidoc/maro.event_buffer.rst

This file was deleted.

202 changes: 202 additions & 0 deletions docs/source/apidoc/maro.rl.rst
@@ -0,0 +1,202 @@
Agent
================================================================================

maro.rl.agent.abs\_agent
--------------------------------------------------------------------------------

.. automodule:: maro.rl.agent.abs_agent
:members:
:undoc-members:
:show-inheritance:

maro.rl.agent.abs\_agent\_manager
--------------------------------------------------------------------------------

.. automodule:: maro.rl.agent.abs_agent_manager
:members:
:undoc-members:
:show-inheritance:


Algorithms
================================================================================

maro.rl.algorithms.torch.abs\_algorithm
--------------------------------------------------------------------------------

.. automodule:: maro.rl.algorithms.torch.abs_algorithm
:members:
:undoc-members:
:show-inheritance:

maro.rl.algorithms.torch.dqn
--------------------------------------------------------------------------------

.. automodule:: maro.rl.algorithms.torch.dqn
:members:
:undoc-members:
:show-inheritance:


Models
================================================================================

maro.rl.models.torch.learning\_model
--------------------------------------------------------------------------------

.. automodule:: maro.rl.models.torch.learning_model
:members:
:undoc-members:
:show-inheritance:


Explorer
================================================================================

maro.rl.explorer.abs\_explorer
--------------------------------------------------------------------------------

.. automodule:: maro.rl.explorer.abs_explorer
:members:
:undoc-members:
:show-inheritance:

maro.rl.explorer.simple\_explorer
--------------------------------------------------------------------------------

.. automodule:: maro.rl.explorer.simple_explorer
:members:
:undoc-members:
:show-inheritance:


Shaping
================================================================================

maro.rl.shaping.abs\_shaper
--------------------------------------------------------------------------------

.. automodule:: maro.rl.shaping.abs_shaper
:members:
:undoc-members:
:show-inheritance:

maro.rl.shaping.action\_shaper
--------------------------------------------------------------------------------

.. automodule:: maro.rl.shaping.action_shaper
:members:
:undoc-members:
:show-inheritance:

maro.rl.shaping.experience\_shaper
--------------------------------------------------------------------------------

.. automodule:: maro.rl.shaping.experience_shaper
:members:
:undoc-members:
:show-inheritance:

maro.rl.shaping.k\_step\_experience\_shaper
--------------------------------------------------------------------------------

.. automodule:: maro.rl.shaping.k_step_experience_shaper
:members:
:undoc-members:
:show-inheritance:

maro.rl.shaping.state\_shaper
--------------------------------------------------------------------------------

.. automodule:: maro.rl.shaping.state_shaper
:members:
:undoc-members:
:show-inheritance:


Storage
================================================================================

maro.rl.storage.abs\_store
--------------------------------------------------------------------------------

.. automodule:: maro.rl.storage.abs_store
:members:
:undoc-members:
:show-inheritance:

maro.rl.storage.column\_based\_store
--------------------------------------------------------------------------------

.. automodule:: maro.rl.storage.column_based_store
:members:
:undoc-members:
:show-inheritance:

maro.rl.storage.utils
--------------------------------------------------------------------------------

.. automodule:: maro.rl.storage.utils
:members:
:undoc-members:
:show-inheritance:


Actor
================================================================================

maro.rl.actor.abs\_actor
--------------------------------------------------------------------------------

.. automodule:: maro.rl.actor.abs_actor
:members:
:undoc-members:
:show-inheritance:

maro.rl.actor.simple\_actor
--------------------------------------------------------------------------------

.. automodule:: maro.rl.actor.simple_actor
:members:
:undoc-members:
:show-inheritance:


Learner
================================================================================

maro.rl.learner.abs\_learner
--------------------------------------------------------------------------------

.. automodule:: maro.rl.learner.abs_learner
:members:
:undoc-members:
:show-inheritance:

maro.rl.learner.simple\_learner
--------------------------------------------------------------------------------

.. automodule:: maro.rl.learner.simple_learner
:members:
:undoc-members:
:show-inheritance:


Distributed Topologies
================================================================================

maro.rl.dist\_topologies.common
--------------------------------------------------------------------------------

.. automodule:: maro.rl.dist_topologies.common
:members:
:undoc-members:
:show-inheritance:

maro.rl.dist\_topologies.single\_learner\_multi\_actor\_sync\_mode
--------------------------------------------------------------------------------

.. automodule:: maro.rl.dist_topologies.single_learner_multi_actor_sync_mode
:members:
:undoc-members:
:show-inheritance:
33 changes: 18 additions & 15 deletions docs/source/apidoc/maro.rst
@@ -1,22 +1,25 @@
MARO Package
============

Subpackages
-----------
Simulation Toolkit
================================================================================

.. toctree::
:maxdepth: 4

maro.backends
maro.event_buffer
maro.data_lib
maro.simulator
maro.utils

Module Contents
---------------

.. automodule:: maro
:members:
:undoc-members:
:show-inheritance:
RL Toolkit
================================================================================

.. toctree::
:maxdepth: 4

maro.rl


Utils
================================================================================

.. toctree::
:maxdepth: 4

maro.utils
62 changes: 45 additions & 17 deletions docs/source/apidoc/maro.simulator.rst
@@ -1,28 +1,56 @@
maro.simulator package
======================
Data Model
================================================================================

Subpackages
-----------
maro.backends.frame
--------------------------------------------------------------------------------

.. toctree::
:maxdepth: 4
.. automodule:: maro.backends.frame
:members:
:show-inheritance:


Event Buffer
================================================================================

maro.event_buffer.event_buffer
--------------------------------------------------------------------------------

.. automodule:: maro.event_buffer.event_buffer
:members:
:show-inheritance:

maro.simulator.scenarios
maro.simulator.utils

Submodules
----------
Business Engine
================================================================================

maro.simulator.abs\_core module
-------------------------------
maro.simulator.scenarios.abs_business_engine
--------------------------------------------------------------------------------

.. automodule:: maro.simulator.abs_core
.. automodule:: maro.simulator.scenarios.abs_business_engine
:members:
:show-inheritance:

maro.simulator.core module
--------------------------

.. automodule:: maro.simulator.core
Utils
================================================================================

maro.simulator.utils.common
--------------------------------------------------------------------------------

.. automodule:: maro.simulator.utils.common
:members:
:show-inheritance:
:show-inheritance:

maro.simulator.utils.event\_bind\_binreader
--------------------------------------------------------------------------------

.. automodule:: maro.simulator.utils.event_bind_binreader
:members:
:show-inheritance:

maro.simulator.utils.sim\_random
--------------------------------------------------------------------------------

.. automodule:: maro.simulator.utils.sim_random
:members:
:show-inheritance:

0 comments on commit 702e3cd

Please sign in to comment.