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

V0.1 #97

Merged
merged 106 commits into from
Sep 25, 2020
Merged

V0.1 #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
106 commits
Select commit Hold shift + click to select a range
3fb488c
setup v0.1
Sep 18, 2020
8db3ca0
rm \n in comments
Sep 18, 2020
0739290
QuickStart added for docs.scenarios
Sep 21, 2020
d93905b
experiment result of citi bike update to 1-month version
Sep 21, 2020
870a4b3
V0.1 issues installation (#38)
ArthurJiang Sep 21, 2020
a50085d
notebook link added for scenarios
Sep 21, 2020
9aed86e
fix: add missing licenses, refine long lines (#36)
romickid Sep 21, 2020
36baa90
scenario notebook update (#39)
Jinyu-W Sep 21, 2020
f9fdb06
scenario doc modified according to comments
Sep 22, 2020
f90b861
doc correction
Sep 22, 2020
1c1f571
scenario doc modified according to comments
Sep 22, 2020
59d148a
merge with v0.1
Sep 22, 2020
fc8f4a1
remove examples
Sep 22, 2020
a30d5d4
rl toolkit refactoring (#42)
ArthurJiang Sep 22, 2020
5efc96d
fix issue during building playground images (#44)
kaiqli Sep 22, 2020
67e7271
citibike doc modified according to comments
Sep 22, 2020
1420f6d
citibike doc update
Sep 22, 2020
cefc787
scenario experiment result table changed
Sep 22, 2020
e6ca9ad
Merge branch 'v0.1' into v0.1_docs_scenario
Sep 22, 2020
4b1537b
Merge branch 'v0.1' into v0.1_doc_correction
Sep 22, 2020
61a14b2
Merge pull request #40 from microsoft/v0.1_doc_correction
Jinyu-W Sep 22, 2020
6d4fab9
annotate the empty experiment results
Sep 22, 2020
7a945a5
Merge branch 'v0.1' into v0.1_docs_scenario
Sep 22, 2020
6041a04
Merge pull request #37 from microsoft/v0.1_docs_scenario
Jinyu-W Sep 22, 2020
dc7d24c
merge master into v0.1 for later merging (#47)
chaosddp Sep 22, 2020
24e9a5e
Merge branch 'master' into v0.1
ArthurJiang Sep 22, 2020
07a232c
Merge branch 'master' into v0.1
Sep 22, 2020
181526f
refine readme
Sep 22, 2020
ba91712
Merge branch 'master' into v0.1
Sep 22, 2020
4dd87ac
fix: recursive copy instead of plain copy (#45)
romickid Sep 22, 2020
e68ddb9
update maro overall image
Sep 22, 2020
6ada59f
Merge branch 'v0.1' of https://github.com/microsoft/maro into v0.1
Sep 22, 2020
75736df
typo
Sep 22, 2020
47f5d62
add key components
Sep 22, 2020
3d5065f
fix deployment issue in multi envs (#49)
zhawan Sep 22, 2020
a651bb8
typo
Sep 22, 2020
36e6cfa
refine introduction
Sep 22, 2020
ebc8618
fix typo
Sep 22, 2020
8637a68
Merge branch 'master' into v0.1
Sep 22, 2020
5ecb207
fix readme
Sep 22, 2020
7fbeae7
Merge branch 'master' into v0.1
ArthurJiang Sep 22, 2020
5131133
refine readme
Sep 22, 2020
5a2bd1a
Merge branch 'v0.1' of https://github.com/microsoft/maro into v0.1
Sep 22, 2020
4911874
refine readme
Sep 22, 2020
aa682dc
Merge branch 'master' into v0.1
ArthurJiang Sep 22, 2020
f2ad3e9
update readme docs link
Sep 22, 2020
f2b811f
fix ~/.maro not exist issue in build (#52)
zhawan Sep 22, 2020
4be8c8f
refine logo
Sep 22, 2020
1586d35
fix toctree
Sep 22, 2020
0737f5a
fix & feat: invalid filename & maro grass status (#51)
romickid Sep 22, 2020
fca949c
refine
Sep 22, 2020
b714a15
refine
Sep 22, 2020
6257882
Merge branch 'v0.1' of https://github.com/microsoft/maro into v0.1
Sep 22, 2020
33641ce
Merge branch 'master' into v0.1
ArthurJiang Sep 22, 2020
ef485fa
V0.1 test store update (#58)
ysqyang Sep 23, 2020
1a5da08
rename ecr 2 cim (#62)
chaosddp Sep 23, 2020
79c5a7e
V0.1 rename to cim in example (#63)
ysqyang Sep 23, 2020
4e0c8ef
fix ut issue under window, now all runpass (#64)
chaosddp Sep 23, 2020
41296bc
V0.1 ecr rename (#65)
Jinyu-W Sep 23, 2020
9e921dd
temporarily disable weather, fix station id issue (#66)
zhawan Sep 23, 2020
9065110
V0.1 ecr rename (#67)
Jinyu-W Sep 23, 2020
823c8b4
change the keys in metrics (#68)
chaosddp Sep 23, 2020
c90ee62
update setup
Sep 23, 2020
0541786
Merge branch 'master' into v0.1
Sep 23, 2020
c52ab3a
Update build_wheel.yml
ArthurJiang Sep 23, 2020
84b10ab
Update build_wheel.yml
ArthurJiang Sep 23, 2020
9084b66
Update build_wheel.yml
ArthurJiang Sep 23, 2020
db0091f
Update build_wheel.yml
ArthurJiang Sep 23, 2020
030c4e7
rm install from PyPi
Sep 23, 2020
0a8699c
Merge branch 'master' into v0.1
Sep 23, 2020
8f94f4b
V0.1 cim nb (#70)
ysqyang Sep 23, 2020
b33786c
the font size of doc diagrams is enlarged (#73)
Jinyu-W Sep 23, 2020
fdaa133
str() and repr() of DecisionEvent and Action added; notebook output u…
Jinyu-W Sep 23, 2020
cf75a87
Update deploy_gh_pages.yml
ArthurJiang Sep 23, 2020
dd952c5
fix docker build
Sep 23, 2020
ac05707
V0.1 feature docker ci (#77)
ArthurJiang Sep 23, 2020
0e4c9ff
Merge branch 'master' into v0.1
ArthurJiang Sep 23, 2020
9c4ac56
update playground docs
Sep 23, 2020
79c1dbf
fixed a key error in K-step shaper for CIM (#80)
ysqyang Sep 24, 2020
cbff9fd
V0.1 baseline results (#81)
Jinyu-W Sep 24, 2020
c099e8e
duplicated notebook removed
Sep 24, 2020
5ea38f7
update distributed example (#69)
kaiqli Sep 24, 2020
7ba08c1
repalce title with caps
Sep 24, 2020
73d7379
Merge branch 'v0.1' of github.com:microsoft/maro into v0.1
Sep 24, 2020
78a6662
add test and build badge (#76)
chaosddp Sep 24, 2020
7a7dfda
Merge branch 'master' into v0.1
ArthurJiang Sep 24, 2020
7b0c7a8
V0.1 k step key error fix (#84)
ysqyang Sep 24, 2020
bad607e
Merge branch 'master' into v0.1
ArthurJiang Sep 24, 2020
a553cd3
fixed unpicklable bug in k step shaper (#87)
ysqyang Sep 24, 2020
16ff2a0
Merge branch 'master' into v0.1
Sep 24, 2020
7b7ff3c
Update and rename unittests.yml to test.yml
ArthurJiang Sep 24, 2020
272e748
Merge branch 'v0.1' of github.com:microsoft/maro into v0.1
Sep 24, 2020
03a405a
code block format update
Sep 24, 2020
b78a393
Merge branch 'v0.1' of github.com:microsoft/maro into v0.1
Sep 24, 2020
4bcfafc
removed sentence above title (#90)
ysqyang Sep 24, 2020
66b8c28
cim results update * 20 (#88)
Jinyu-W Sep 24, 2020
b44bf60
V0.1 import bug fix in example (#86)
ysqyang Sep 24, 2020
06459ce
updated citibike resposition number column
Sep 24, 2020
210d9cd
Merge remote-tracking branch 'origin/v0.1' into v0.1_update_citibike_…
Sep 24, 2020
871afd0
fixed table formatiing
Sep 24, 2020
c79bf83
Merge pull request #92 from microsoft/v0.1_update_citibike_baseline_r…
Jinyu-W Sep 24, 2020
4df12ef
Merge branch 'master' into v0.1
Sep 24, 2020
3c7af94
Update setup.py
ArthurJiang Sep 25, 2020
e45a452
Merge branch 'master' into v0.1
Sep 25, 2020
58b832f
Merge branch 'master' into v0.1
Sep 25, 2020
e0365dd
fix pypi meta
Sep 25, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[![build](https://github.com/microsoft/maro/workflows/build/badge.svg)](https://github.com/microsoft/maro/actions?query=workflow%3Abuild)
[![docker](https://github.com/microsoft/maro/workflows/docker/badge.svg)](https://hub.docker.com/repository/docker/arthursjiang/maro)
[![docs](https://readthedocs.org/projects/maro/badge/?version=latest)](https://maro.readthedocs.io/)
[![Python Versions](https://img.shields.io/pypi/v/pymaro)](https://pypi.org/project/pymaro/#files)
[![Python Versions](https://img.shields.io/pypi/pyversions/pymaro.svg?logo=python&logoColor=white)](https://pypi.org/project/pymaro/#files)

# ![MARO LOGO](./docs/source/images/logo.svg)

Expand Down Expand Up @@ -34,9 +36,22 @@ of user-defined functions for message auto-handling, cluster provision, and job
| `examples` | Showcase of MARO. |
| `notebooks` | MARO quick-start notebooks. |

## Prerequisites
## Install MARO from [PyPI](https://pypi.org/project/pymaro/#files)

- [Python == 3.6/3.7](https://www.python.org/downloads/)
- Max OS / Linux

```sh
pip install pymaro
```

- Windows

```powershell
# Install torch first, if you don't have one.
pip install torch===1.6.0 torchvision===0.7.0 -f https://download.pytorch.org/whl/torch_stable.html

pip install pymaro
```

## Install MARO from Source ([Editable Mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs))

Expand Down
13 changes: 1 addition & 12 deletions docker_files/cpu.play.df
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
# Step 1: build maro
FROM quay.io/pypa/manylinux2010_x86_64 as ext_build

WORKDIR /maro_build

ADD ./maro ./maro
ADD README.md ./README.md
ADD LICENSE ./LICENSE
ADD setup.py ./setup.py
RUN PYBIN="/opt/python/cp36-cp36m/bin"; "${PYBIN}/pip" install -r maro/requirements.build.txt; "${PYBIN}/python" setup.py bdist_wheel --plat-name manylinux2010_x86_64

# Step 2: build playground image
FROM python:3.6

WORKDIR /maro_playground
Expand All @@ -22,9 +13,7 @@ RUN jupyter contrib nbextension install --system
RUN jt -t onedork -fs 95 -altp -tfs 11 -nfs 115 -cellw 88% -T

# Install maro
COPY --from=ext_build /maro_build/dist/maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl ./maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN pip install maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN rm maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
pip install pymaro

# Install redis
RUN wget http://download.redis.io/releases/redis-6.0.6.tar.gz; tar xzf redis-6.0.6.tar.gz; cd redis-6.0.6; make
Expand Down
18 changes: 1 addition & 17 deletions docker_files/cpu.runtime.df
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
# Step 1: build maro
FROM quay.io/pypa/manylinux2010_x86_64 as ext_build

WORKDIR /maro_build

# Build wheels
ADD ./maro ./maro
ADD setup.py ./setup.py
ADD README.md ./README.md
ADD LICENSE ./LICENSE
RUN PYBIN="/opt/python/cp36-cp36m/bin"; "${PYBIN}/pip" install -r maro/requirements.build.txt; "${PYBIN}/python" setup.py bdist_wheel --plat-name manylinux2010_x86_64


# Step 2: Install components
FROM python:3.6-buster

ENV DEBIAN_FRONTEND noninteractive
Expand All @@ -38,6 +24,4 @@ RUN pip install psutil==5.7.2
RUN pip install deepdiff==5.0.2

# Install maro
COPY --from=ext_build /maro_build/dist/maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl ./maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN pip install maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN rm maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
pip install pymaro
18 changes: 1 addition & 17 deletions docker_files/gpu.runtime.df
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
# Step 1: build maro
FROM quay.io/pypa/manylinux2010_x86_64 as ext_build

WORKDIR /maro_build

# Build wheels
ADD ./maro ./maro
ADD setup.py ./setup.py
ADD README.md ./README.md
ADD LICENSE ./LICENSE
RUN PYBIN="/opt/python/cp36-cp36m/bin"; "${PYBIN}/pip" install -r maro/requirements.build.txt; "${PYBIN}/python" setup.py bdist_wheel --plat-name manylinux2010_x86_64


# Step 2: Install components
FROM nvidia/cuda:11.0-runtime-ubuntu18.04

ENV DEBIAN_FRONTEND noninteractive
Expand Down Expand Up @@ -43,6 +29,4 @@ RUN pip install psutil==5.7.2
RUN pip install deepdiff==5.0.2

# Install maro
COPY --from=ext_build /maro_build/dist/maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl ./maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN pip install maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
RUN rm maro-0.1.1a0-cp36-cp36m-manylinux2010_x86_64.whl
pip install pymaro
19 changes: 15 additions & 4 deletions docs/source/installation/pip_install.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# Package

## Install from PyPI Using `pip`
## Install MARO from [PyPI](https://pypi.org/project/pymaro/#files)

```sh
pip install maro
```
- Max OS / Linux

```sh
pip install pymaro
```

- Windows

```powershell
# Install torch first, if you don't have one.
pip install torch===1.6.0 torchvision===0.7.0 -f https://download.pytorch.org/whl/torch_stable.html

pip install pymaro
```

## Install MARO from Source ([Editable Mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs))

Expand Down
2 changes: 1 addition & 1 deletion maro/__misc__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
# Licensed under the MIT license.


__version__ = "0.1.1a4"
__version__ = "0.1.1a5"

__data_version__ = "0.1"
27 changes: 17 additions & 10 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.

######################################################################################
pk_description = """
Multi-Agent Resource Optimization (MARO) platform is an instance of Reinforcement
learning as a Service (RaaS) for real-world resource optimization.
"""
######################################################################################

from glob import glob
import io
import os
from setuptools import setup, find_packages, Extension
from setuptools.command.install import install
Expand Down Expand Up @@ -77,10 +71,14 @@
include_dirs=include_dirs)
)

readme = io.open("README.md", encoding="utf-8").read()

setup(
name="pymaro",
version=__version__,
description=pk_description,
description="MARO Python Package",
long_description=readme,
long_description_content_typ="text/markdown",
author="Arthur Jiang",
author_email="shujia.jiang@microsoft.com",
url="https://github.com/microsoft/maro",
Expand All @@ -93,9 +91,18 @@
platforms=["Windows", "Linux", "macOS"],
keywords=["citi-bike", "inventory-management", "operations-research", "reinforcement-learning", "resource-optimization", "simulator"],
classifiers=[
# See <https://pypi.org/classifiers/> for all classifiers
'Intended Audience :: Science/Research',
'License :: OSI Approved :: MIT License',
'Natural Language :: English',
'Operating System :: MacOS',
'Operating System :: Microsoft :: Windows',
'Operating System :: POSIX',
'Operating System :: Unix',
"Programing Language :: Python",
"Programing Language :: Python :: 3"
"Programing Language :: Python :: 3",
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Topic :: Scientific/Engineering :: Artificial Intelligence'
],
python_requires=">=3.6,<3.8",
setup_requires=[
Expand Down