Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3602b6c
Showing
27 changed files
with
2,298 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# The Google Cloud Platform Python runtime is based on Debian Jessie | ||
# You can read more about the runtime at: | ||
# https://github.com/GoogleCloudPlatform/python-runtime | ||
FROM gcr.io/google_appengine/python | ||
|
||
RUN apt-get update | ||
RUN apt-get -y install python3 python3-pip python3-dev build-essential | ||
|
||
COPY requirements.txt /app/ | ||
RUN pip3 install --requirement /app/requirements.txt | ||
COPY . /app/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
Copyright 2018 The Gin-Config Authors. All rights reserved. | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright [yyyy] [name of copyright owner] | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
# Run Evolution Strategies on Google Kubernetes Engine | ||
|
||
## Introduction | ||
|
||
Evolution Strategies (ES) performs iterative optimization with a large population of trials that are usually distributedly conducted. | ||
[Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/) (GKE) serves as a good platform for ES. | ||
We hope the instructions and code here serves as a quickstart for researchers to run their ES experiments on GKE. | ||
Please refer to the blog [here] for more information about the repository. | ||
You are also strongly recommended to read this [blog](http://blog.otoro.net/2017/10/29/visual-evolution-strategies/) that provides excellent explanations if you want to know more about ES. | ||
|
||
|
||
![Learning time comparison in BipedalWalkerHardcore](https://storage.googleapis.com/gcp_blog/img/bipedal_time_comparison.png) | ||
![Learning time comparison in MinitaurLocomotion](https://storage.googleapis.com/gcp_blog/img/minitaur_time_comparison.png) | ||
|
||
## How to use the code | ||
|
||
The ES algorithms we provide as samples are Parameter-exploring Policy Gradients (PEPG) and Covariance Matrix Adaptation (CMA). | ||
You can play with them in Google Brain's [Minitaur Locomotion](https://github.com/bulletphysics/bullet3/tree/master/examples/pybullet/gym/pybullet_envs/minitaur/envs) and OpenAI's [BipedalWalkerHardcore-v2](https://github.com/openai/gym/wiki/Leaderboard#bipedalwalkerhardcore-v2). | ||
You can also easily extend the code here to add your ES algorithms or change the configs to try the algorithms in your own environments. | ||
|
||
### Run the demos on GKE | ||
|
||
#### 1. Before you begin | ||
|
||
You need a cluster on Google Cloud Platform (GCP) to run the demos, follow the instructions [here](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster) to create yours. | ||
We use the following commands / configs to create our cluster, feel free to change these to suit your needs. | ||
```Bash | ||
GCLOUD_PROJECT={your-project-id} | ||
|
||
gcloud container clusters create es-cluster \ | ||
--zone=us-central1-a \ | ||
--machine-type=n1-standard-64 \ | ||
--max-nodes=20 \ | ||
--min-nodes=17 \ | ||
--num-nodes=17 \ | ||
--enable-autoscaling \ | ||
--project ${GCLOUD_PROJECT} | ||
``` | ||
|
||
#### 2. Follow the instructions to deploy a demo | ||
|
||
The following command builds a container image for you. | ||
You need to generate a new image if you have changed the code, remember to change the image version number when you do so. | ||
```Bash | ||
gcloud builds submit \ | ||
--tag gcr.io/${GCLOUD_PROJECT}/es-on-gke:1.0 . \ | ||
--timeout 3600 \ | ||
--project ${GCLOUD_PROJECT} | ||
``` | ||
|
||
When the container image is built, edit `yaml/deploy_workers.yaml` and `yaml/deploy_master.yaml` to | ||
* replace the `spec.template.spec.containers.image` with the one you just built | ||
* change the `--config` parameter in `spec.template.spec.containers.command` to the environment you want to run | ||
|
||
Replace `${GCLOUD_PROJECT}` in the following 2 yaml files with your project ID, | ||
then start the ES workers and the ES master: | ||
```Bash | ||
# Run these commands to start workers. | ||
sed "s/\${GCLOUD_PROJECT}/${GCLOUD_PROJECT}/g" yaml/deploy_workers_bipedal.yaml > workers.yaml | ||
kubectl apply -f workers.yaml | ||
|
||
# When all the workers are running, run these command to start the master. | ||
sed "s/\${GCLOUD_PROJECT}/${GCLOUD_PROJECT}/g" yaml/deploy_master_bipedal.yaml > master.yaml | ||
kubectl apply -f master.yaml | ||
``` | ||
After a while you should be able to see your pods started in GCP console: | ||
![Pod started](https://storage.googleapis.com/gcp_blog/img/start_master_workers.png) | ||
|
||
That's all! ES should be training in your specified environment on GKE now. | ||
|
||
#### 3. Check training progress and results | ||
|
||
We provide 3 ways for you to check the training progress: | ||
1. **Stackdriver** In GCP console, clicking GKE's Workloads page gives your detailed status report of your pods. | ||
Go to the details of the `es-master-pod` and you can find "Container logs" there that will direct you to the Stackdriver's logging where you can see training and test rewards. | ||
2. **HTTP Server** In our code, we start a simple HTTP server in the master to make training logs easily accessible to you. | ||
You can access by checking the endpoint in `es-master-service` located in GKE's Services page. (The server may need some time to start up.) | ||
3. **Kubectl** Finally you can use the *kubectl* command to fetch logs and models. | ||
The following commands serve as examples. | ||
|
||
```bash | ||
POD_NAME=$(kubectl get pod | grep es-master | awk '{print $1}') | ||
|
||
# Download reward vs time plot. | ||
kubectl cp $POD_NAME:/var/log/es/log/reward_vs_time.png $HOME/ | ||
# Download reward vs iteration plot. | ||
kubectl cp $POD_NAME:/var/log/es/log/reward_vs_iteration.png $HOME/ | ||
# Download best model so far. | ||
kubectl cp $POD_NAME:/var/log/es/log/best_model.npz $HOME/ | ||
# Download model at iteration 1000. | ||
kubectl cp $POD_NAME:/var/log/es/log/model_1000.npz $HOME/ | ||
# Download all test scores. | ||
kubectl cp $POD_NAME:/var/log/es/log/scores.csv $HOME/ | ||
``` | ||
|
||
|
||
### Run the demos locally | ||
|
||
As a debugging process, both training and test can be run locally. | ||
Use `train_local.sh` and `test.py`, and add proper options to do so. | ||
```Bash | ||
# train locally | ||
bash ./train_local.sh -c {path-to-config-file} -n {number-of-workers} | ||
|
||
# test locally | ||
python test.py --logdir={path-to-log-directory} | ||
``` | ||
|
||
### Clean up | ||
|
||
When the tasks are done, you can download all the training logs and models: | ||
```bash | ||
# ssh into the container | ||
kubectl exec -it $POD_NAME /bin/bash | ||
# In the container, make a tar ball of logs and then exit | ||
tar -cvf log.tar /var/log/es && exit | ||
# Download the tar ball | ||
kubectl cp $POD_NAME:/app/log.tar $HOME/ | ||
``` | ||
|
||
Finally, if you don't need to run any tasks, don't forget to [delete the cluster](https://cloud.google.com/dataproc/docs/guides/manage-cluster). |
Empty file.
Oops, something went wrong.