Skip to content

Commit 0ae2942

Browse files
committed
Update wrapper docs
1 parent 544fd45 commit 0ae2942

File tree

8 files changed

+9
-79
lines changed

8 files changed

+9
-79
lines changed
Lines changed: 1 addition & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1 @@
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],
71-
version 1.4, available at
72-
https://www.contributor-covenant.org/version/1/4/code-of-conduct/
73-
74-
[homepage]: https://www.contributor-covenant.org
1+
{!../../CODE_OF_CONDUCT.md!}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{!../../CONTRIBUTING.md!}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{!../LICENSE.md!}
1+
{!../../LICENSE.md!}

com.unity.ml-agents/Documentation~/Learning-Environment-Examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page only overviews the example environments we provide. To learn more on
1818
how to design and build your own environments see our
1919
[Making a New Learning Environment](Learning-Environment-Create-New.md) page. If
2020
you would like to contribute environments, please see our
21-
[contribution guidelines](../CONTRIBUTING.md) page.
21+
[contribution guidelines](CONTRIBUTING.md) page.
2222

2323
## Basic
2424

com.unity.ml-agents/Documentation~/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_22_docs/docs/)
44

5-
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](../LICENSE.md)
5+
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE.md)
66

77
([latest release](https://github.com/Unity-Technologies/ml-agents/releases/tag/latest_release))
88
([all releases](https://github.com/Unity-Technologies/ml-agents/releases))

com.unity.ml-agents/Documentation~/Reference-Support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ The Reference & Support section contains essential documentation for ongoing ML-
1010
| [Migrating](Migrating.md) | Migration guides for updating between ML-Agents versions. |
1111
| [Versioning](Versioning.md) | Information about ML-Agents versioning and release notes. |
1212
| [ML-Agents Glossary](Glossary.md) | Glossary of terms and concepts used in ML-Agents. |
13+
| [C# API Reference](API-Reference.md) | C# API documentation generated from code comments. |

com.unity.ml-agents/Documentation~/TableOfContents.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
* [Migrating](Migrating.md)
4545
* [versioning](Versioning.md)
4646
* [ML-Agents Glossary](Glossary.md)
47+
* [C# API Reference](API-Reference.md)
4748
* [Background](Background.md)
4849
* [Machine Learning](Background-Machine-Learning.md)
4950
* [Unity](Background-Unity.md)

com.unity.ml-agents/Documentation~/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Note that the C# package does not contain the machine learning algorithms for tr
1919
| [Python Tutorial with Google Colab](Tutorial-Colab.md) | Interactive tutorials for using ML-Agents with Google Colab. |
2020
| [Advanced Features](Advanced-Features.md) | Custom sensors, side channels, package settings, environment registry, and input system integrations. |
2121
| [Cloud & Deployment](Cloud-Deployment.md) | Legacy cloud deployment guides (deprecated). |
22-
| [Reference & Support](Reference-Support.md) | FAQ, troubleshooting, and migration guides. |
22+
| [Reference & Support](Reference-Support.md) | FAQ, troubleshooting, migration guides, and C# API reference. |
2323
| [Background](Background.md) | Machine Learning, Unity, PyTorch fundamentals, virtual environments, and ELO rating systems. |
2424

2525
## Capabilities
@@ -34,7 +34,7 @@ The package allows you to convert any Unity scene into a learning environment an
3434

3535
The ML-Agents Toolkit is an open-source project, and we encourage and welcome
3636
contributions. If you wish to contribute, be sure to review our
37-
[contribution guidelines](../CONTRIBUTING.md) and
37+
[contribution guidelines](CONTRIBUTING.md) and
3838
[code of conduct](CODE_OF_CONDUCT.md).
3939

4040
For problems with the installation and setup of the ML-Agents Toolkit, or

0 commit comments

Comments
 (0)