Skip to content

Commit 0b32bd4

Browse files
author
Ruo-Ping (Rachel) Dong
authored
Update release_9 versions (#4621)
1 parent 79faafd commit 0b32bd4

File tree

16 files changed

+40
-39
lines changed

16 files changed

+40
-39
lines changed

‎README.md‎

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

33
# Unity ML-Agents Toolkit
44

5-
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/)
5+
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/)
66

77
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE)
88

@@ -48,8 +48,8 @@ descriptions of all these features.
4848

4949
## Releases & Documentation
5050

51-
**Our latest, stable release is `Release 8`. Click
52-
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/Readme.md)
51+
**Our latest, stable release is `Release 9`. Click
52+
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/Readme.md)
5353
to get started with the latest release of ML-Agents.**
5454

5555
The table below lists all our releases, including our `master` branch which is
@@ -67,13 +67,13 @@ under active development and may be unstable. A few helpful guidelines:
6767
| **Version** | **Release Date** | **Source** | **Documentation** | **Download** |
6868
|:-------:|:------:|:-------------:|:-------:|:------------:|
6969
| **master (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/master) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/master/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/master.zip) |
70-
| **Release 8** | **October 14, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_8)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_8.zip)** |
70+
| **Release 9** | **November 4, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_9)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_9.zip)** |
71+
| **Release 8** | October 14, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_8) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_8.zip) |
7172
| **Release 7** | September 16, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_7) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_7_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_7.zip) |
7273
| **Release 6** | August 12, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_6) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_6_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_6.zip) |
7374
| **Release 5** | July 31, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_5) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_5_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_5.zip) |
7475
| **Release 4** | July 15, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_4) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_4_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_4.zip) |
7576
| **Release 3** | June 10, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_3) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_3_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_3.zip) |
76-
| **Release 2** | May 20, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_2) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_2.zip) |
7777

7878
## Citation
7979

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ a number of ways to [connect with us] including our [ML-Agents Forum].
114114
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
115115
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
116116
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
117-
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Installation.md
117+
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Installation.md
118118
[github repository]: https://github.com/Unity-Technologies/ml-agents
119119
[python package]: https://github.com/Unity-Technologies/ml-agents
120120
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html

‎com.unity.ml-agents/Runtime/Academy.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* API. For more information on each of these entities, in addition to how to
2121
* set-up a learning environment and train the behavior of characters in a
2222
* Unity scene, please browse our documentation pages on GitHub:
23-
* https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/
23+
* https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/
2424
*/
2525

2626
namespace Unity.MLAgents
@@ -61,7 +61,7 @@ void FixedUpdate()
6161
/// fall back to inference or heuristic decisions. (You can also set agents to always use
6262
/// inference or heuristics.)
6363
/// </remarks>
64-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/" +
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/" +
6565
"docs/Learning-Environment-Design.md")]
6666
public class Academy : IDisposable
6767
{

‎com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public interface IActionReceiver
160160
///
161161
/// See [Agents - Actions] for more information on masking actions.
162162
///
163-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
163+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
164164
/// </remarks>
165165
/// <seealso cref="IActionReceiver.OnActionReceived"/>
166166
void WriteDiscreteActionMask(IDiscreteActionMask actionMask);

‎com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public interface IDiscreteActionMask
1717
///
1818
/// See [Agents - Actions] for more information on masking actions.
1919
///
20-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
20+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
2121
/// </remarks>
2222
/// <param name="branch">The branch for which the actions will be masked.</param>
2323
/// <param name="actionIndices">The indices of the masked actions.</param>

‎com.unity.ml-agents/Runtime/Agent.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -148,13 +148,13 @@ public void CopyActions(ActionBuffers actionBuffers)
148148
/// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html]
149149
/// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html
150150
/// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html
151-
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md
152-
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design.md
151+
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md
152+
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design.md
153153
/// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
154-
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Readme.md
154+
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Readme.md
155155
///
156156
/// </remarks>
157-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/" +
157+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/" +
158158
"docs/Learning-Environment-Design-Agents.md")]
159159
[Serializable]
160160
[RequireComponent(typeof(BehaviorParameters))]
@@ -630,8 +630,8 @@ public int CompletedEpisodes
630630
/// for information about mixing reward signals from curiosity and Generative Adversarial
631631
/// Imitation Learning (GAIL) with rewards supplied through this method.
632632
///
633-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#rewards
634-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
633+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#rewards
634+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
635635
/// </remarks>
636636
/// <param name="reward">The new value of the reward.</param>
637637
public void SetReward(float reward)
@@ -660,8 +660,8 @@ public void SetReward(float reward)
660660
/// for information about mixing reward signals from curiosity and Generative Adversarial
661661
/// Imitation Learning (GAIL) with rewards supplied through this method.
662662
///
663-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#rewards
664-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
663+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#rewards
664+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
665665
///</remarks>
666666
/// <param name="increment">Incremental reward value.</param>
667667
public void AddReward(float increment)
@@ -839,8 +839,8 @@ public virtual void Initialize() { }
839839
/// implementing a simple heuristic function can aid in debugging agent actions and interactions
840840
/// with its environment.
841841
///
842-
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
843-
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
842+
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
843+
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
844844
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
845845
/// </remarks>
846846
/// <example>
@@ -1087,7 +1087,7 @@ void ResetSensors()
10871087
/// For more information about observations, see [Observations and Sensors].
10881088
///
10891089
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
1090-
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
1090+
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
10911091
/// </remarks>
10921092
public virtual void CollectObservations(VectorSensor sensor)
10931093
{
@@ -1118,7 +1118,7 @@ public ReadOnlyCollection<float> GetObservations()
11181118
///
11191119
/// See [Agents - Actions] for more information on masking actions.
11201120
///
1121-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
1121+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
11221122
/// </remarks>
11231123
/// <seealso cref="IActionReceiver.OnActionReceived"/>
11241124
public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
@@ -1193,7 +1193,7 @@ public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
11931193
///
11941194
/// For more information about implementing agent actions see [Agents - Actions].
11951195
///
1196-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
1196+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
11971197
/// </remarks>
11981198
/// <param name="actions">
11991199
/// Struct containing the buffers of actions to be executed at this step.

‎com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ namespace Unity.MLAgents.Demonstrations
1919
/// See [Imitation Learning - Recording Demonstrations] for more information.
2020
///
2121
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
22-
/// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations
22+
/// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations
2323
/// </remarks>
2424
[RequireComponent(typeof(Agent))]
2525
[AddComponentMenu("ML Agents/Demonstration Recorder", (int)MenuGroup.Default)]

‎com.unity.ml-agents/Runtime/DiscreteActionMasker.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ internal DiscreteActionMasker(IDiscreteActionMask actionMask)
3333
///
3434
/// See [Agents - Actions] for more information on masking actions.
3535
///
36-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
36+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
3737
/// </remarks>
3838
/// <param name="branch">The branch for which the actions will be masked.</param>
3939
/// <param name="actionIndices">The indices of the masked actions.</param>

‎docs/Installation-Anaconda-Windows.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@ commands in an Anaconda Prompt _(if you open a new prompt, be sure to activate
123123
the ml-agents Conda environment by typing `activate ml-agents`)_:
124124

125125
```sh
126-
git clone --branch release_8 https://github.com/Unity-Technologies/ml-agents.git
126+
git clone --branch release_9 https://github.com/Unity-Technologies/ml-agents.git
127127
```
128128

129-
The `--branch release_8` option will switch to the tag of the latest stable
129+
The `--branch release_9` option will switch to the tag of the latest stable
130130
release. Omitting that will get the `master` branch which is potentially
131131
unstable.
132132

‎docs/Installation.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ example environments and training configurations to experiment with them (some
5858
of our tutorials / guides assume you have access to our example environments).
5959

6060
```sh
61-
git clone --branch release_8 https://github.com/Unity-Technologies/ml-agents.git
61+
git clone --branch release_9 https://github.com/Unity-Technologies/ml-agents.git
6262
```
6363

64-
The `--branch release_8` option will switch to the tag of the latest stable
64+
The `--branch release_9` option will switch to the tag of the latest stable
6565
release. Omitting that will get the `master` branch which is potentially
6666
unstable.
6767

6868
#### Advanced: Local Installation for Development
6969

7070
You will need to clone the repository if you plan to modify or extend the
7171
ML-Agents Toolkit for your purposes. If you plan to contribute those changes
72-
back, make sure to clone the `master` branch (by omitting `--branch release_8`
72+
back, make sure to clone the `master` branch (by omitting `--branch release_9`
7373
from the command above). See our
7474
[Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more
7575
information on contributing to the ML-Agents Toolkit.

0 commit comments

Comments
 (0)