This repository has been archived by the owner on Aug 28, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BabyAI experiments, license, coc, contributing
BabyAI experiments COC, Contributing and License Add link to license in README
- Loading branch information
Showing
36 changed files
with
5,657 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,5 @@ | ||
# Code of Conduct | ||
|
||
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. | ||
Please read the [full text](https://code.fb.com/codeofconduct/) | ||
so that you can understand what actions will and will not be tolerated |
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,35 @@ | ||
# Contributing to modeling_long_term_future | ||
We want to make contributing to this project as easy and transparent as | ||
possible. | ||
|
||
## Our Development Process | ||
... (in particular how this is synced with internal changes to the project) | ||
|
||
## Pull Requests | ||
We actively welcome your pull requests. | ||
|
||
1. Fork the repo and create your branch from `master`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. If you haven't already, complete the Contributor License Agreement ("CLA"). | ||
|
||
## Contributor License Agreement ("CLA") | ||
In order to accept your pull request, we need you to submit a CLA. You only need | ||
to do this once to work on any of Facebook's open source projects. | ||
|
||
Complete your CLA here: <https://code.facebook.com/cla> | ||
|
||
## Issues | ||
We use GitHub issues to track public bugs. Please ensure your description is | ||
clear and has sufficient instructions to be able to reproduce the issue. | ||
|
||
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe | ||
disclosure of security bugs. In those cases, please go through the process | ||
outlined on that page and do not file a public issue. | ||
|
||
|
||
## License | ||
By contributing to modeling_long_term_future, you agree that your contributions will be licensed | ||
under the LICENSE file in the root directory of this source tree. |
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,277 @@ | ||
Attribution-NonCommercial 4.0 International | ||
|
||
======================================================================= | ||
|
||
Creative Commons Corporation ("Creative Commons") is not a law firm and | ||
does not provide legal services or legal advice. Distribution of | ||
Creative Commons public licenses does not create a lawyer-client or | ||
other relationship. Creative Commons makes its licenses and related | ||
information available on an "as-is" basis. Creative Commons gives no | ||
warranties regarding its licenses, any material licensed under their | ||
terms and conditions, or any related information. Creative Commons | ||
disclaims all liability for damages resulting from their use to the | ||
fullest extent possible. | ||
|
||
Using Creative Commons Public Licenses | ||
|
||
Creative Commons public licenses provide a standard set of terms and | ||
conditions that creators and other rights holders may use to share | ||
original works of authorship and other material subject to copyright | ||
and certain other rights specified in the public license below. The | ||
following considerations are for informational purposes only, are not | ||
exhaustive, and do not form part of our licenses. | ||
|
||
Considerations for licensors: Our public licenses are | ||
intended for use by those authorized to give the public | ||
permission to use material in ways otherwise restricted by | ||
copyright and certain other rights. Our licenses are | ||
irrevocable. Licensors should read and understand the terms | ||
and conditions of the license they choose before applying it. | ||
Licensors should also secure all rights necessary before | ||
applying our licenses so that the public can reuse the | ||
material as expected. Licensors should clearly mark any | ||
material not subject to the license. This includes other CC- | ||
licensed material, or material used under an exception or | ||
limitation to copyright. More considerations for licensors: | ||
wiki.creativecommons.org/Considerations_for_licensors | ||
|
||
Considerations for the public: By using one of our public | ||
licenses, a licensor grants the public permission to use the | ||
licensed material under specified terms and conditions. If | ||
the licensor's permission is not necessary for any reason--for | ||
example, because of any applicable exception or limitation to | ||
copyright--then that use is not regulated by the license. Our | ||
licenses grant only permissions under copyright and certain | ||
other rights that a licensor has authority to grant. Use of | ||
the licensed material may still be restricted for other | ||
reasons, including because others have copyright or other | ||
rights in the material. A licensor may make special requests, | ||
such as asking that all changes be marked or described. | ||
Although not required by our licenses, you are encouraged to | ||
respect those requests where reasonable. More_considerations | ||
for the public: | ||
wiki.creativecommons.org/Considerations_for_licensees | ||
|
||
======================================================================= | ||
|
||
Creative Commons Attribution-NonCommercial 4.0 International Public | ||
License | ||
|
||
By exercising the Licensed Rights (defined below), You accept and agree | ||
to be bound by the terms and conditions of this Creative Commons | ||
Attribution-NonCommercial 4.0 International Public License ("Public | ||
License"). To the extent this Public License may be interpreted as a | ||
contract, You are granted the Licensed Rights in consideration of Your | ||
acceptance of these terms and conditions, and the Licensor grants You | ||
such rights in consideration of benefits the Licensor receives from | ||
making the Licensed Material available under these terms and | ||
conditions. | ||
|
||
Section 1 -- Definitions. | ||
|
||
a. Adapted Material means material subject to Copyright and Similar | ||
Rights that is derived from or based upon the Licensed Material | ||
and in which the Licensed Material is translated, altered, | ||
arranged, transformed, or otherwise modified in a manner requiring | ||
permission under the Copyright and Similar Rights held by the | ||
Licensor. For purposes of this Public License, where the Licensed | ||
Material is a musical work, performance, or sound recording, | ||
Adapted Material is always produced where the Licensed Material is | ||
synched in timed relation with a moving image. | ||
|
||
b. Adapter's License means the license You apply to Your Copyright | ||
and Similar Rights in Your contributions to Adapted Material in | ||
accordance with the terms and conditions of this Public License. | ||
|
||
c. Copyright and Similar Rights means copyright and/or similar rights | ||
closely related to copyright including, without limitation, | ||
performance, broadcast, sound recording, and Sui Generis Database | ||
Rights, without regard to how the rights are labeled or | ||
categorized. For purposes of this Public License, the rights | ||
specified in Section 2(b)(1)-(2) are not Copyright and Similar | ||
Rights. | ||
d. Effective Technological Measures means those measures that, in the | ||
absence of proper authority, may not be circumvented under laws | ||
fulfilling obligations under Article 11 of the WIPO Copyright | ||
Treaty adopted on December 20, 1996, and/or similar international | ||
agreements. | ||
|
||
e. Exceptions and Limitations means fair use, fair dealing, and/or | ||
any other exception or limitation to Copyright and Similar Rights | ||
that applies to Your use of the Licensed Material. | ||
|
||
f. Licensed Material means the artistic or literary work, database, | ||
or other material to which the Licensor applied this Public | ||
License. | ||
|
||
g. Licensed Rights means the rights granted to You subject to the | ||
terms and conditions of this Public License, which are limited to | ||
all Copyright and Similar Rights that apply to Your use of the | ||
Licensed Material and that the Licensor has authority to license. | ||
|
||
h. Licensor means the individual(s) or entity(ies) granting rights | ||
under this Public License. | ||
|
||
i. NonCommercial means not primarily intended for or directed towards | ||
commercial advantage or monetary compensation. For purposes of | ||
this Public License, the exchange of the Licensed Material for | ||
other material subject to Copyright and Similar Rights by digital | ||
file-sharing or similar means is NonCommercial provided there is | ||
no payment of monetary compensation in connection with the | ||
exchange. | ||
|
||
j. Share means to provide material to the public by any means or | ||
process that requires permission under the Licensed Rights, such | ||
as reproduction, public display, public performance, distribution, | ||
dissemination, communication, or importation, and to make material | ||
available to the public including in ways that members of the | ||
public may access the material from a place and at a time | ||
individually chosen by them. | ||
|
||
k. Sui Generis Database Rights means rights other than copyright | ||
resulting from Directive 96/9/EC of the European Parliament and of | ||
the Council of 11 March 1996 on the legal protection of databases, | ||
as amended and/or succeeded, as well as other essentially | ||
equivalent rights anywhere in the world. | ||
|
||
l. You means the individual or entity exercising the Licensed Rights | ||
under this Public License. Your has a corresponding meaning. | ||
|
||
Section 2 -- Scope. | ||
|
||
a. License grant. | ||
|
||
1. Subject to the terms and conditions of this Public License, | ||
the Licensor hereby grants You a worldwide, royalty-free, | ||
non-sublicensable, non-exclusive, irrevocable license to | ||
exercise the Licensed Rights in the Licensed Material to: | ||
|
||
a. reproduce and Share the Licensed Material, in whole or | ||
in part, for NonCommercial purposes only; and | ||
|
||
b. produce, reproduce, and Share Adapted Material for | ||
NonCommercial purposes only. | ||
|
||
2. Exceptions and Limitations. For the avoidance of doubt, where | ||
Exceptions and Limitations apply to Your use, this Public | ||
License does not apply, and You do not need to comply with | ||
its terms and conditions. | ||
|
||
3. Term. The term of this Public License is specified in Section | ||
6(a). | ||
|
||
4. Media and formats; technical modifications allowed. The | ||
Licensor authorizes You to exercise the Licensed Rights in | ||
all media and formats whether now known or hereafter created, | ||
and to make technical modifications necessary to do so. The | ||
Licensor waives and/or agrees not to assert any right or | ||
authority to forbid You from making technical modifications | ||
necessary to exercise the Licensed Rights, including | ||
technical modifications necessary to circumvent Effective | ||
Technological Measures. For purposes of this Public License, | ||
simply making modifications authorized by this Section 2(a) | ||
(4) never produces Adapted Material. | ||
|
||
5. Downstream recipients. | ||
|
||
a. Offer from the Licensor -- Licensed Material. Every | ||
recipient of the Licensed Material automatically | ||
receives an offer from the Licensor to exercise the | ||
Licensed Rights under the terms and conditions of this | ||
Public License. | ||
|
||
b. No downstream restrictions. You may not offer or impose | ||
any additional or different terms or conditions on, or | ||
apply any Effective Technological Measures to, the | ||
Licensed Material if doing so restricts exercise of the | ||
Licensed Rights by any recipient of the Licensed | ||
Material. | ||
|
||
6. No endorsement. Nothing in this Public License constitutes or | ||
may be construed as permission to assert or imply that You | ||
are, or that Your use of the Licensed Material is, connected | ||
with, or sponsored, endorsed, or granted official status by, | ||
the Licensor or others designated to receive attribution as | ||
provided in Section 3(a)(1)(A)(i). | ||
|
||
b. Other rights. | ||
|
||
1. Moral rights, such as the right of integrity, are not | ||
licensed under this Public License, nor are publicity, | ||
privacy, and/or other similar personality rights; however, to | ||
the extent possible, the Licensor waives and/or agrees not to | ||
assert any such rights held by the Licensor to the limited | ||
extent necessary to allow You to exercise the Licensed | ||
Rights, but not otherwise. | ||
|
||
2. Patent and trademark rights are not licensed under this | ||
Public License. | ||
|
||
3. To the extent possible, the Licensor waives any right to | ||
collect royalties from You for the exercise of the Licensed | ||
Rights, whether directly or through a collecting society | ||
under any voluntary or waivable statutory or compulsory | ||
licensing scheme. In all other cases the Licensor expressly | ||
reserves any right to collect such royalties, including when | ||
the Licensed Material is used other than for NonCommercial | ||
purposes. | ||
|
||
Section 3 -- License Conditions. | ||
|
||
Your exercise of the Licensed Rights is expressly made subject to the | ||
following conditions. | ||
|
||
a. Attribution. | ||
|
||
1. If You Share the Licensed Material (including in modified | ||
form), You must: | ||
|
||
a. retain the following if it is supplied by the Licensor | ||
with the Licensed Material: | ||
|
||
i. identification of the creator(s) of the Licensed | ||
Material and any others designated to receive | ||
attribution, in any reasonable manner requested by | ||
the Licensor (including by pseudonym if | ||
designated); | ||
|
||
ii. a copyright notice; | ||
|
||
iii. a notice that refers to this Public License; | ||
|
||
iv. a notice that refers to the disclaimer of | ||
warranties; | ||
|
||
v. a URI or hyperlink to the Licensed Material to the | ||
extent reasonably practicable; | ||
|
||
b. indicate if You modified the Licensed Material and | ||
retain an indication of any previous modifications; and | ||
|
||
c. indicate the Licensed Material is licensed under this | ||
Public License, and include the text of, or the URI or | ||
hyperlink to, this Public License. | ||
|
||
2. You may satisfy the conditions in Section 3(a)(1) in any | ||
reasonable manner based on the medium, means, and context in | ||
which You Share the Licensed Material. For example, it may be | ||
reasonable to satisfy the conditions by providing a URI or | ||
hyperlink to a resource that includes the required | ||
information. | ||
|
||
3. If requested by the Licensor, You must remove any of the | ||
information required by Section 3(a)(1)(A) to the extent | ||
reasonably practicable. | ||
|
||
4. If You Share Adapted Material You produce, the Adapter's | ||
License You apply must not prevent recipients of the Adapted | ||
Material from complying with this Public License. | ||
|
||
Section 4 -- Sui Generis Database Rights. | ||
|
||
Where the Licensed Rights include Sui Generis Database Rights that | ||
apply to Your use of the Licensed Material: | ||
|
||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right | ||
to extract, reuse, reproduce, and Share all or a substantial | ||
portion of the contents of the |
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,70 @@ | ||
This repo contains code for our paper [Learning Dynamics Model in Reinforcement Learning by Incorporating the Long Term Future](https://arxiv.org/abs/1903.01599) | ||
|
||
The code base contains multiple branches. | ||
|
||
- The main branch contains experiments for the BabyAI tasks. | ||
- The mujoco branch contains experiments for the Mujoco tasks. | ||
|
||
Based on code base for the BabyAI project at Mila. https://github.com/mila-iqia/babyai | ||
|
||
Follow similar installations as in https://github.com/mila-iqia/babyai. | ||
|
||
|
||
Requirements: | ||
## Installation | ||
|
||
Requirements: | ||
- Python 3.5+ | ||
- OpenAI Gym | ||
- NumPy | ||
- PyQT5 | ||
- PyTorch 0.4.1+ | ||
|
||
Start by manually installing PyTorch. See the [PyTorch website](http://pytorch.org/) | ||
for installation instructions specific to your platform. | ||
|
||
Then, clone this repository and install the other dependencies with `pip3`: | ||
|
||
git clone https://github.com/nke001/iclr_babyai | ||
cd babyai | ||
pip3 install --editable . | ||
|
||
Create a new conda env using env.yml in the repo | ||
|
||
## Training teacher | ||
|
||
We use the BabyAI Pickup-Unlock game. | ||
|
||
First train the teacher (for imitation learning) using PPO with curriculum learning. Start with a room size of 6 and then work our way up to room size of 15. | ||
|
||
|
||
python3 -m scripts.train_curclm. --env BabyAI-UnlockPickup-v0 --algo ppo --arch cnn1 --tb --seed 1 --save-interval 10 --room-size 6 | ||
python3 -m scripts.train_curclm. --env BabyAI-UnlockPickup-v0 --algo ppo --arch cnn1 --tb --seed 1 --save-interval 10 --room-size 8 --model MODEL_ROOM6_PRETRAINED | ||
python3 -m scripts.train_curclm. --env BabyAI-UnlockPickup-v0 --algo ppo --arch cnn1 --tb --seed 1 --save-interval 10 --room-size 10 --model MODEL_ROOM8_PRETRAINED | ||
python3 -m scripts.train_curclm. --env BabyAI-UnlockPickup-v0 --algo ppo --arch cnn1 --tb --seed 1 --save-interval 10 --room-size 12 --model MODEL_ROOM10_PRETRAINED | ||
python3 -m scripts.train_curclm. --env BabyAI-UnlockPickup-v0 --algo ppo --arch cnn1 --tb --seed 1 --save-interval 10 --room-size 15 --model MODEL_ROOM12_PRETRAINED | ||
|
||
|
||
## Generate expert trajectories | ||
|
||
Generate expert trajectories from the experts trained using curriculum learning | ||
|
||
mnkdir data | ||
python3 -m scripts.gen_samples --episodes 10000 --env BabyAI-UnlockPickup-v0 --model pretrained_model_room_10 --room 10 | ||
|
||
|
||
## Training the student to imitate the expert | ||
|
||
To run our model | ||
|
||
python3 -m scripts.zforcing_main_state_dec --env BabyAI-UnlockPickup-v0 --datafile EXPERT_DATA_TO_LOAD --model MODEL_NAME --eval-episodes 100 --eval-interval 200 --bwd-weight 0.0 --lr 1e-4 --aux-weight-start 0.0001 --bwd-l2-weight 1. --kld-weight-start 0.2 --aux-weight-end 0.0001 --room 10 | ||
|
||
|
||
To run the baseline | ||
|
||
python3 -m scripts.zforcing_main_state_dec --datafile EXPERT_DATA_TO_LOAD --env BabyAI-UnlockPickup-v0 --model MODEL_NAME --eval-episodes 100 --eval-interval 200 --bwd-weight 0.0 --lr 1e-4 --aux-weight-start 0.000 --aux-weight-end 0.0 --room 10 | ||
|
||
|
||
## License | ||
|
||
Find license in [LICENSE](LICENSE) file. |
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,4 @@ | ||
# Import levels so that the OpenAI Gym environments get registered | ||
# when the babyai package is imported | ||
from . import levels | ||
from . import utils |
Empty file.
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 @@ | ||
from .levels import level_dict |
Oops, something went wrong.