From 65a74230a2bf976e46bd9a822da0b6dbb51d95e3 Mon Sep 17 00:00:00 2001 From: Mehdi Fatemi Date: Tue, 29 Oct 2019 12:11:02 -0400 Subject: [PATCH] update legal notes --- CONTRIBUTING.md | 14 +++++++++++++ LICENSE | 2 ++ NOTICE.md | 4 ++++ README.md | 4 +++- linear_experiments/agent.py | 5 +++++ linear_experiments/domain.py | 5 +++++ linear_experiments/main.py | 5 +++++ linear_experiments/show_results.py | 5 +++++ log_dqn_experiments/log_dqn/__init__.py | 6 ++++++ .../log_dqn/circular_replay_buffer_64.py | 20 +++++++++++++++++++ log_dqn_experiments/log_dqn/log_dqn_agent.py | 20 +++++++++++++++++++ log_dqn_experiments/log_dqn/train_atari.py | 20 +++++++++++++++++++ log_dqn_experiments/setup.py | 5 +++++ 13 files changed, 114 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md create mode 100644 NOTICE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c282e9a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to +agree to a Contributor License Agreement (CLA) declaring that you have the right to, +and actually do, grant us the rights to use your contribution. For details, visit +https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need +to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the +instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/LICENSE b/LICENSE index 3d8b93b..98915bc 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,7 @@ MIT License + LOGARITHMIC REINFORCEMENT LEARNING + Copyright (c) Microsoft Corporation. Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..c577552 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,4 @@ +## OSS License Notice + +The files in the `log_dqn_experiments/log_dqn +` folder are mostly derived from [Dopamine](https://github.com/google/dopamine). Please see the original license [here](https://github.com/google/dopamine/blob/master/LICENSE). \ No newline at end of file diff --git a/README.md b/README.md index 7eeebb4..5f69d7b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This repository hosts sample code for the NeurIPS 2019 paper: [van Seijen, Fatem We provide code for the linear experiments of the paper as well as the deep RL Atari 2600 examples (LogDQN). -## For the license, please see [LICENSE](https://github.com/microsoft/logrl/blob/master/LICENSE). +## [LICENSE](https://github.com/microsoft/logrl/blob/master/LICENSE) + +## [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct) The code for LogDQN has been developed by [Arash Tavakoli](https://atavakol.github.io/) and the code for the linear experiments has been developed by [Harm van Seijen](mailto:Harm.vanSeijen@microsoft.com). diff --git a/linear_experiments/agent.py b/linear_experiments/agent.py index 132517f..b0d41ea 100644 --- a/linear_experiments/agent.py +++ b/linear_experiments/agent.py @@ -1,3 +1,8 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + import numpy as np class Agent(object): diff --git a/linear_experiments/domain.py b/linear_experiments/domain.py index 86a7fdb..bcf9343 100644 --- a/linear_experiments/domain.py +++ b/linear_experiments/domain.py @@ -1,3 +1,8 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + import numpy as np import math diff --git a/linear_experiments/main.py b/linear_experiments/main.py index 8f15cfd..b735719 100644 --- a/linear_experiments/main.py +++ b/linear_experiments/main.py @@ -1,3 +1,8 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + import numpy as np import json import time diff --git a/linear_experiments/show_results.py b/linear_experiments/show_results.py index f23d497..1e95182 100644 --- a/linear_experiments/show_results.py +++ b/linear_experiments/show_results.py @@ -1,3 +1,8 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + import numpy as np import math import json diff --git a/log_dqn_experiments/log_dqn/__init__.py b/log_dqn_experiments/log_dqn/__init__.py index 5b39072..20d0c45 100644 --- a/log_dqn_experiments/log_dqn/__init__.py +++ b/log_dqn_experiments/log_dqn/__init__.py @@ -1 +1,7 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + + name = "log_dqn" \ No newline at end of file diff --git a/log_dqn_experiments/log_dqn/circular_replay_buffer_64.py b/log_dqn_experiments/log_dqn/circular_replay_buffer_64.py index f8d9306..8a7610d 100644 --- a/log_dqn_experiments/log_dqn/circular_replay_buffer_64.py +++ b/log_dqn_experiments/log_dqn/circular_replay_buffer_64.py @@ -1,3 +1,23 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + +# This file is derived from Dopamine with the following original copyright note: +# Copyright 2018 The Dopamine Authors. +# +# 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. + """The standard DQN replay memory modified to support float64 rewards. This script modifies the Dopamine's implementation of an out-of-graph diff --git a/log_dqn_experiments/log_dqn/log_dqn_agent.py b/log_dqn_experiments/log_dqn/log_dqn_agent.py index 86c9f6c..e203071 100644 --- a/log_dqn_experiments/log_dqn/log_dqn_agent.py +++ b/log_dqn_experiments/log_dqn/log_dqn_agent.py @@ -1,3 +1,23 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + +# This file is partially derived from Dopamine with the following original copyright note: +# Copyright 2018 The Dopamine Authors. +# +# 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. + """Compact implementation of a LogDQN agent. Details in "Using a Logarithmic Mapping to Enable Lower Discount Factors diff --git a/log_dqn_experiments/log_dqn/train_atari.py b/log_dqn_experiments/log_dqn/train_atari.py index 29b4d32..b64c236 100644 --- a/log_dqn_experiments/log_dqn/train_atari.py +++ b/log_dqn_experiments/log_dqn/train_atari.py @@ -1,3 +1,23 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + +# This file is partially derived from Dopamine with the following original copyright note: +# Copyright 2018 The Dopamine Authors. +# +# 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. + r"""The entry point for running an agent on an Atari 2600 domain. This script modifies Dopamine's `train.py` to support LogDQN. diff --git a/log_dqn_experiments/setup.py b/log_dqn_experiments/setup.py index 41e6add..2e01c8b 100644 --- a/log_dqn_experiments/setup.py +++ b/log_dqn_experiments/setup.py @@ -1,3 +1,8 @@ +''' +Copyright (c) Microsoft Corporation. +Licensed under the MIT license. +''' + import codecs from os import path from setuptools import find_packages