浏览代码
Moving UnitySDK README to correct location, fixing file permissions. (#1175)
/develop-generalizationTraining-TrainerController
Moving UnitySDK README to correct location, fixing file permissions. (#1175)
/develop-generalizationTraining-TrainerController
GitHub
7 年前
当前提交
6aa78593
共有 9 个文件被更改,包括 1520 次插入 和 0 次删除
-
92.gitignore
-
201LICENSE
-
99README.md
-
611docs/images/banner.png
-
129docs/images/player_brain.png
-
79docs/images/scene-hierarchy.png
-
309docs/images/unity-logo-rgb.png
-
0/UnitySDK/README.md
|
|||
/UnitySDK/[Ll]ibrary/ |
|||
/UnitySDK/[Tt]emp/ |
|||
/UnitySDK/[Oo]bj/ |
|||
/UnitySDK/[Bb]uild/ |
|||
/UnitySDK/[Bb]uilds/ |
|||
/UnitySDK/[Pp]ackages/ |
|||
/UnitySDK/[Uu]nity[Pp]ackage[Mm]anager/ |
|||
/UnitySDK/Assets/AssetStoreTools* |
|||
/UnitySDK/Assets/Plugins* |
|||
/UnitySDK/Assets/Gizmos* |
|||
|
|||
# Tensorflow Model Info |
|||
/models |
|||
/summaries |
|||
|
|||
# Environemnt logfile |
|||
*UnitySDK.log |
|||
|
|||
# Visual Studio 2015 cache directory |
|||
/UnitySDK/.vs/ |
|||
|
|||
# Autogenerated VS/MD/Consulo solution and project files |
|||
/UnitySDKExportedObj/ |
|||
/UnitySDK.consulo/ |
|||
*.csproj |
|||
*.unityproj |
|||
*.sln |
|||
*.suo |
|||
*.tmp |
|||
*.user |
|||
*.userprefs |
|||
*.pidb |
|||
*.booproj |
|||
*.svd |
|||
*.pdb |
|||
|
|||
# Unity3D generated meta files |
|||
*.pidb.meta |
|||
|
|||
# Unity3D Generated File On Crash Reports |
|||
/UnitySDK/sysinfo.txt |
|||
|
|||
# Builds |
|||
*.apk |
|||
*.unitypackage |
|||
*.app |
|||
*.exe |
|||
*.x86_64 |
|||
*.x86 |
|||
|
|||
# Tensorflow Sharp Files |
|||
/UnitySDK/Assets/ML-Agents/Plugins/Android* |
|||
/UnitySDK/Assets/ML-Agents/Plugins/iOS* |
|||
/UnitySDK/Assets/ML-Agents/Plugins/Computer* |
|||
/UnitySDK/Assets/ML-Agents/Plugins/System* |
|||
|
|||
# Generated doc folders |
|||
/docs/html |
|||
|
|||
# Mac hidden files |
|||
*.DS_Store |
|||
*/.ipynb_checkpoints |
|||
*/.idea |
|||
*.pyc |
|||
*.idea/misc.xml |
|||
*.idea/modules.xml |
|||
*.iml |
|||
*.xml |
|||
*.cache |
|||
*/build/ |
|||
*/dist/ |
|||
*.egg-info* |
|||
*.eggs* |
|||
*.gitignore.swp |
|||
|
|||
# VSCode hidden files |
|||
*.vscode/ |
|||
|
|||
.DS_Store |
|||
.ipynb_checkpoints |
|||
|
|||
# pytest cache |
|||
*.pytest_cache/ |
|||
|
|||
# Ignore compiled protobuf files. |
|||
ml-agents-protobuf/cs |
|||
ml-agents-protobuf/python |
|||
ml-agents-protobuf/Grpc* |
|||
|
|||
# Ignore PyPi build files. |
|||
dist/ |
|||
build/ |
|
|||
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 2017 Unity Technologies |
|||
|
|||
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. |
|
|||
<img src="docs/images/unity-wide.png" align="middle" width="3000"/> |
|||
|
|||
<img src="docs/images/image-banner.png" align="middle" width="3000"/> |
|||
|
|||
# Unity ML-Agents Toolkit (Beta) |
|||
|
|||
**The Unity Machine Learning Agents Toolkit** (ML-Agents) is an open-source |
|||
Unity plugin that enables games and simulations to serve as environments for |
|||
training intelligent agents. Agents can be trained using reinforcement learning, |
|||
imitation learning, neuroevolution, or other machine learning methods through a |
|||
simple-to-use Python API. We also provide implementations (based on TensorFlow) |
|||
of state-of-the-art algorithms to enable game developers and hobbyists to easily |
|||
train intelligent agents for 2D, 3D and VR/AR games. These trained agents can be |
|||
used for multiple purposes, including controlling NPC behavior (in a variety of |
|||
settings such as multi-agent and adversarial), automated testing of game builds |
|||
and evaluating different game design decisions pre-release. The ML-Agents |
|||
toolkit is mutually beneficial for both game developers and AI researchers as it |
|||
provides a central platform where advances in AI can be evaluated on Unity’s |
|||
rich environments and then made accessible to the wider research and game |
|||
developer communities. |
|||
|
|||
## Features |
|||
|
|||
* Unity environment control from Python |
|||
* 10+ sample Unity environments |
|||
* Support for multiple environment configurations and training scenarios |
|||
* Train memory-enhanced agents using deep reinforcement learning |
|||
* Easily definable Curriculum Learning scenarios |
|||
* Broadcasting of agent behavior for supervised learning |
|||
* Built-in support for Imitation Learning |
|||
* Flexible agent control with On Demand Decision Making |
|||
* Visualizing network outputs within the environment |
|||
* Simplified set-up with Docker |
|||
|
|||
## Documentation |
|||
|
|||
* For more information, in addition to installation and usage instructions, see |
|||
our [documentation home](docs/Readme.md). |
|||
* If you have used a version of the ML-Agents toolkit prior to v0.4, we strongly |
|||
recommend our [guide on migrating from earlier versions](docs/Migrating.md). |
|||
|
|||
## References |
|||
|
|||
We have published a series of blog posts that are relevant for ML-Agents: |
|||
|
|||
* Overviewing reinforcement learning concepts |
|||
([multi-armed bandit](https://blogs.unity3d.com/2017/06/26/unity-ai-themed-blog-entries/) |
|||
and |
|||
[Q-learning](https://blogs.unity3d.com/2017/08/22/unity-ai-reinforcement-learning-with-q-learning/)) |
|||
* [Using Machine Learning Agents in a real game: a beginner’s guide](https://blogs.unity3d.com/2017/12/11/using-machine-learning-agents-in-a-real-game-a-beginners-guide/) |
|||
* [Post](https://blogs.unity3d.com/2018/02/28/introducing-the-winners-of-the-first-ml-agents-challenge/) |
|||
announcing the winners of our |
|||
[first ML-Agents Challenge](https://connect.unity.com/challenges/ml-agents-1) |
|||
* [Post](https://blogs.unity3d.com/2018/01/23/designing-safer-cities-through-simulations/) |
|||
overviewing how Unity can be leveraged as a simulator to design safer cities. |
|||
|
|||
In addition to our own documentation, here are some additional, relevant articles: |
|||
|
|||
* [Unity AI - Unity 3D Artificial Intelligence](https://www.youtube.com/watch?v=bqsfkGbBU6k) |
|||
* [A Game Developer Learns Machine Learning](https://mikecann.co.uk/machine-learning/a-game-developer-learns-machine-learning-intent/) |
|||
* [Explore Unity Technologies ML-Agents Exclusively on Intel Architecture](https://software.intel.com/en-us/articles/explore-unity-technologies-ml-agents-exclusively-on-intel-architecture) |
|||
|
|||
## Community and Feedback |
|||
|
|||
The ML-Agents toolkit is an open-source project and we encourage and welcome |
|||
contributions. If you wish to contribute, be sure to review our |
|||
[contribution guidelines](CONTRIBUTING.md) and |
|||
[code of conduct](CODE_OF_CONDUCT.md). |
|||
|
|||
You can connect with us and the broader community |
|||
through Unity Connect and GitHub: |
|||
|
|||
* Join our |
|||
[Unity Machine Learning Channel](https://connect.unity.com/messages/c/035fba4f88400000) |
|||
to connect with others using the ML-Agents toolkit and Unity developers |
|||
enthusiastic about machine learning. We use that channel to surface updates |
|||
regarding the ML-Agents toolkit (and, more broadly, machine learning in |
|||
games). |
|||
* If you run into any problems using the ML-Agents toolkit, |
|||
[submit an issue](https://github.com/Unity-Technologies/ml-agents/issues) and |
|||
make sure to include as much detail as possible. |
|||
|
|||
For any other questions or feedback, connect directly with the ML-Agents |
|||
team at ml-agents@unity3d.com. |
|||
|
|||
## Translations |
|||
|
|||
To make the Unity ML-Agents toolkit accessible to the global research and |
|||
Unity developer communities, we're attempting to create and maintain |
|||
translations of our documentation. We've started with translating a subset |
|||
of the documentation to one language (Chinese), but we hope to continue |
|||
translating more pages and to other languages. Consequently, |
|||
we welcome any enhancements and improvements from the community. |
|||
|
|||
* [Chinese](docs/localized/zh-CN/) |
|||
|
|||
## License |
|||
|
|||
[Apache License 2.0](LICENSE) |
撰写
预览
正在加载...
取消
保存
Reference in new issue