Skip to content

Commit 734c9a3

Browse files
Miguel Alonso JrGitHub Enterprise
authored andcommitted
Feature/mla 2394 update web docs (#37)
* Added mkdocs and refactored docs. * Updated docs. * Added gh action to manually public docs. Updated mkdocs.yml.
1 parent 21bba3a commit 734c9a3

File tree

179 files changed

+347
-287
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

179 files changed

+347
-287
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Publish HTML Docs
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
publish:
8+
name: Publish Docs to GH Pages
9+
runs-on: [self-hosted, Linux, X64]
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v2
13+
with:
14+
token: ${{ secrets.PUBLIC_GH_TOKEN }}
15+
- name: Setup Python 3.7
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: 3.7
19+
- name: Publish docs
20+
run: |
21+
pip install mkdocs
22+
git remote add public git@github.com:Unity-Technologies/ml-agents.git
23+
mkdocs gh-deply --clean -r public
24+

README.md

Lines changed: 0 additions & 189 deletions
This file was deleted.

docs/Background-Machine-Learning.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,7 @@ every step, but only when a robot arrives at a success or failure situation), is
111111
a defining characteristic of reinforcement learning and precisely why learning
112112
good policies can be difficult (and/or time-consuming) for complex environments.
113113

114-
<p align="center">
115-
<img src="images/rl_cycle.png" alt="The reinforcement learning cycle."/>
116-
</p>
114+
<div style="text-align: center"><img src="../images/rl_cycle.png" alt="The reinforcement learning lifecycle."></div>
117115

118116
[Learning a policy](https://blogs.unity3d.com/2017/08/22/unity-ai-reinforcement-learning-with-q-learning/)
119117
usually requires many trials and iterative policy updates. More specifically,

docs/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{!../CODE_OF_CONDUCT.md!}

docs/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{!../com.unity.ml-agents/CONTRIBUTING.md!}

docs/Installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ The ML-Agents Toolkit contains several components:
1010
contains experimental C#/Unity components that are not yet ready to be part
1111
of the base `com.unity.ml-agents` package. `com.unity.ml-agents.extensions`
1212
has a direct dependency on `com.unity.ml-agents`.
13-
- Three Python packages:
13+
- Two Python packages:
1414
- [`mlagents`](../ml-agents/) contains the machine learning algorithms that
1515
enables you to train behaviors in your Unity scene. Most users of ML-Agents
1616
will only need to directly install `mlagents`.
17-
- [`mlagents_envs`](../ml-agents-envs/) contains a Python API to interact with
17+
- [`mlagents_envs`](../ml-agents-envs/) contains a set of Python APIs to interact with
1818
a Unity scene. It is a foundational layer that facilitates data messaging
1919
between Unity scene and the Python machine learning algorithms.
2020
Consequently, `mlagents` depends on `mlagents_envs`.

docs/LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{!../LICENSE.md!}

docs/Learning-Environment-Examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example Learning Environments
22

3-
<img src="images/example-envs.png" align="middle" width="3000"/>
3+
<img src="../images/example-envs.png" align="middle" width="3000"/>
44

55
The Unity ML-Agents Toolkit includes an expanding set of example environments
66
that highlight the various features of the toolkit. These environments can also

docs/Learning-Environment-Executable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,5 +194,5 @@ graphics display in the Unity executable. There are two ways to achieve this:
194194

195195
If you want to train with graphics (for example, using camera and visual observations), you'll
196196
need to set up display rendering support (e.g. xvfb) on you server machine. In our
197-
[Colab Notebook Tutorials](Readme.md#python-tutorial-with-google-colab), the Setup section has
197+
[Colab Notebook Tutorials](ML-Agents-Toolkit-Documentation.md#python-tutorial-with-google-colab), the Setup section has
198198
examples of setting up xvfb on servers.

docs/Limitations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
See the package-specific Limitations pages:
44

5-
- [`com.unity.mlagents` Unity package](../com.unity.ml-agents/Documentation~/com.unity.ml-agents.md#known-limitations)
6-
- [`mlagents` Python package](../ml-agents/README.md#limitations)
7-
- [`mlagents_envs` Python package](../ml-agents-envs/README.md#limitations)
5+
- [`com.unity.mlagents` Unity package](com.unity.ml-agents.md)
6+
- [`mlagents` Python package](ML-Agents-README.md)
7+
- [`mlagents_envs` Python package](ML-Agents-Envs-README.md)

0 commit comments

Comments
 (0)