Skip to content

Commit 365de75

Browse files
author
cesar
committed
Adds code of conduct to the repo
1 parent 5938ef6 commit 365de75

File tree

2 files changed

+94
-4
lines changed

2 files changed

+94
-4
lines changed

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
72+
73+
[homepage]: https://www.contributor-covenant.org

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
<img src="images/unity-wide.png" align="middle" width="3000"/>
22

33
# Unity ML - Agents
4-
**Unity Machine Learning Agents** allows researchers and developers to create games and simulations using the Unity Editor which serve as environments where intelligent agents can be trained using reinforcement learning, neuroevolution, or other machine learning methods through a simple-to-use Python API. For more information, see the [wiki page](../../wiki).
54

6-
For a walkthrough on how to train an agent in one of the provided example environments, start [here](../../wiki/Getting-Started-with-Balance-Ball).
5+
**Unity Machine Learning Agents** allows researchers and developers to
6+
create games and simulations using the Unity Editor which serve as
7+
environments where intelligent agents can be trained using
8+
reinforcement learning, neuroevolution, or other machine learning
9+
methods through a simple-to-use Python API. For more information, see
10+
the [wiki page](../../wiki).
11+
12+
For a walkthrough on how to train an agent in one of the provided
13+
example environments, start
14+
[here](../../wiki/Getting-Started-with-Balance-Ball).
715

816
## Features
917
* Unity Engine flexibility and simplicity
@@ -15,7 +23,16 @@ For a walkthrough on how to train an agent in one of the provided example enviro
1523
* Tensorflow Sharp Agent Embedding _[Experimental]_
1624

1725
## Creating an Environment
18-
The _Agents SDK_, including example environment scenes is localted in `unity-environment` folder. For requirements, instructions, and other information, see the contained Readme and the relevant [wiki page](../../wiki/Making-a-new-Unity-Environment).
26+
27+
The _Agents SDK_, including example environment scenes is localted in
28+
`unity-environment` folder. For requirements, instructions, and other
29+
information, see the contained Readme and the relevant
30+
[wiki page](../../wiki/Making-a-new-Unity-Environment).
1931

2032
## Training your Agents
21-
Once you've built a Unity Environment, example Reinforcement Learning algorithms and the Python API are available in the `python` folder. For requirements, instructions, and other information, see the contained Readme and the relevant [wiki page](../../wiki/Unity-Agents---Python-API).
33+
34+
Once you've built a Unity Environment, example Reinforcement Learning
35+
algorithms and the Python API are available in the `python`
36+
folder. For requirements, instructions, and other information, see the
37+
contained Readme and the relevant
38+
[wiki page](../../wiki/Unity-Agents---Python-API).

0 commit comments

Comments
 (0)