Skip to content

Commit a3802a6

Browse files
author
Ervin T
authored
[release_15] Release 15 update versions (#5101)
* Update versions * Fix for validate release links * Update release tag and docs
1 parent 5502efd commit a3802a6

24 files changed

+65
-60
lines changed

README.md

Lines changed: 2 additions & 2 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_14_docs/docs/)
5+
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/)
66

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

@@ -50,7 +50,7 @@ descriptions of all these features.
5050

5151

5252
**Our latest, stable release is `Release 14`. Click
53-
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/docs/Readme.md)
53+
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/Readme.md)
5454
to get started with the latest release of ML-Agents.**
5555

5656
The table below lists all our releases, including our `main` branch which is

com.unity.ml-agents.extensions/Documentation~/Grid-Sensor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ These limitations provided the motivation towards the development of the Grid Se
3838

3939
An image can be thought of as a matrix of a predefined width (W) and a height (H) and each pixel can be thought of as simply an array of length 3 (in the case of RGB), `[Red, Green, Blue]` holding the different channel information of the color (channel) intensities at that pixel location. Thus an image is just a 3 dimensional matrix of size WxHx3. A Grid Observation can be thought of as a generalization of this setup where in place of a pixel there is a "cell" which is an array of length N representing different channel intensities at that cell position. From a Convolutional Neural Network point of view, the introduction of multiple channels in an "image" isn't a new concept. One such example is using an RGB-Depth image which is used in several robotics applications. The distinction of Grid Observations is what the data within the channels represents. Instead of limiting the channels to color intensities, the channels within a cell of a Grid Observation generalize to any data that can be represented by a single number (float or int).
4040

41-
Before jumping into the details of the Grid Sensor, an important thing to note is the agent performance and qualitatively different behavior over raycasts. Unity MLAgent's comes with a suite of example environments. One in particular, the [Food Collector](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development.
41+
Before jumping into the details of the Grid Sensor, an important thing to note is the agent performance and qualitatively different behavior over raycasts. Unity MLAgent's comes with a suite of example environments. One in particular, the [Food Collector](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development.
4242

4343
The Food Collector environment can be described as:
4444
* Set-up: A multi-agent environment where agents compete to collect food.

com.unity.ml-agents.extensions/Documentation~/Match3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Our aim is to enable Match-3 teams to leverage ML-Agents to create player agents
1010
This implementation includes:
1111

1212
* C# implementation catered toward a Match-3 setup including concepts around encoding for moves based on [Human Like Playtesting with Deep Learning](https://www.researchgate.net/publication/328307928_Human-Like_Playtesting_with_Deep_Learning)
13-
* An example Match-3 scene with ML-Agents implemented (located under /Project/Assets/ML-Agents/Examples/Match3). More information, on Match-3 example [here](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/docs/docs/Learning-Environment-Examples.md#match-3).
13+
* An example Match-3 scene with ML-Agents implemented (located under /Project/Assets/ML-Agents/Examples/Match3). More information, on Match-3 example [here](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/docs/Learning-Environment-Examples.md#match-3).
1414

1515
### Feedback
1616
If you are a Match-3 developer and are trying to leverage ML-Agents for this scenario, [we want to hear from you](https://forms.gle/TBsB9jc8WshgzViU9). Additionally, we are also looking for interested Match-3 teams to speak with us for 45 minutes. If you are interested, please indicate that in the [form](https://forms.gle/TBsB9jc8WshgzViU9). If selected, we will provide gift cards as a token of appreciation.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,24 @@ The ML-Agents Extensions package is not currently available in the Package Manag
2929
recommended ways to install the package:
3030

3131
### Local Installation
32-
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
33-
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/docs/Installation.md#advanced-local-installation-for-development-1)
32+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
33+
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/docs/Installation.md#advanced-local-installation-for-development-1)
3434
directions (substituting `com.unity.ml-agents.extensions` for the package name).
3535

3636
### Github via Package Manager
3737
In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL".
3838

39-
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/images/unity_package_manager_git_url.png)
39+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/images/unity_package_manager_git_url.png)
4040

4141
In the dialog that appears, enter
4242
```
43-
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_14
43+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_15
4444
```
4545

4646
You can also edit your project's `manifest.json` directly and add the following line to the `dependencies`
4747
section:
4848
```
49-
"com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_14",
49+
"com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_15",
5050
```
5151
See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this
5252
may take several minutes to resolve the packages the first time that you add it.
@@ -68,4 +68,4 @@ following versions of the Unity Editor:
6868
- No way to customize the action space of the `InputActuatorComponent`
6969

7070
## Need Help?
71-
The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_14_docs/README.md) contains links for contacting the team or getting support.
71+
The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/README.md) contains links for contacting the team or getting support.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "com.unity.ml-agents.extensions",
33
"displayName": "ML Agents Extensions",
4-
"version": "0.2.0-preview",
4+
"version": "0.3.0-preview",
55
"unity": "2018.4",
66
"description": "A source-only package for new features based on ML-Agents",
77
"dependencies": {
8-
"com.unity.ml-agents": "1.8.1-preview"
8+
"com.unity.ml-agents": "1.9.0-preview"
99
}
1010
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@ Please refer to "Information that is passively collected by Unity" in the
123123
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
124124
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
125125
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
126-
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Installation.md
126+
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Installation.md
127127
[github repository]: https://github.com/Unity-Technologies/ml-agents
128128
[python package]: https://github.com/Unity-Technologies/ml-agents
129129
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html
130130
[connect with us]: https://github.com/Unity-Technologies/ml-agents#community-and-feedback
131131
[ml-agents forum]: https://forum.unity.com/forums/ml-agents.453/
132-
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/com.unity.ml-agents.extensions
132+
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/com.unity.ml-agents.extensions

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

Lines changed: 3 additions & 3 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_14_docs/docs/
23+
* https://github.com/Unity-Technologies/ml-agents/tree/release_15_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_14_docs/" +
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_15_docs/" +
6565
"docs/Learning-Environment-Design.md")]
6666
public class Academy : IDisposable
6767
{
@@ -107,7 +107,7 @@ public class Academy : IDisposable
107107
/// Unity package version of com.unity.ml-agents.
108108
/// This must match the version string in package.json and is checked in a unit test.
109109
/// </summary>
110-
internal const string k_PackageVersion = "1.8.1-preview";
110+
internal const string k_PackageVersion = "1.9.0-preview";
111111

112112
const int k_EditorTrainingPort = 5004;
113113

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ public interface IActionReceiver
218218
///
219219
/// See [Agents - Actions] for more information on masking actions.
220220
///
221-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#actions
221+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#actions
222222
/// </remarks>
223223
/// <seealso cref="IActionReceiver.OnActionReceived"/>
224224
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_14_docs/docs/Learning-Environment-Design-Agents.md#actions
20+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_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
@@ -185,13 +185,13 @@ public override BuiltInActuatorType GetBuiltInActuatorType()
185185
/// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html]
186186
/// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html
187187
/// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html
188-
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md
189-
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design.md
188+
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md
189+
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design.md
190190
/// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
191-
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Readme.md
191+
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Readme.md
192192
///
193193
/// </remarks>
194-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/" +
194+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/" +
195195
"docs/Learning-Environment-Design-Agents.md")]
196196
[Serializable]
197197
[RequireComponent(typeof(BehaviorParameters))]
@@ -700,8 +700,8 @@ public int CompletedEpisodes
700700
/// for information about mixing reward signals from curiosity and Generative Adversarial
701701
/// Imitation Learning (GAIL) with rewards supplied through this method.
702702
///
703-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#rewards
704-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
703+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#rewards
704+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
705705
/// </remarks>
706706
/// <param name="reward">The new value of the reward.</param>
707707
public void SetReward(float reward)
@@ -730,8 +730,8 @@ public void SetReward(float reward)
730730
/// for information about mixing reward signals from curiosity and Generative Adversarial
731731
/// Imitation Learning (GAIL) with rewards supplied through this method.
732732
///
733-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#rewards
734-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
733+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#rewards
734+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
735735
///</remarks>
736736
/// <param name="increment">Incremental reward value.</param>
737737
public void AddReward(float increment)
@@ -925,8 +925,8 @@ public virtual void Initialize() { }
925925
/// implementing a simple heuristic function can aid in debugging agent actions and interactions
926926
/// with its environment.
927927
///
928-
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
929-
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#actions
928+
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
929+
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#actions
930930
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
931931
/// </remarks>
932932
/// <example>
@@ -1189,7 +1189,7 @@ void ResetSensors()
11891189
/// For more information about observations, see [Observations and Sensors].
11901190
///
11911191
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
1192-
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
1192+
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
11931193
/// </remarks>
11941194
public virtual void CollectObservations(VectorSensor sensor)
11951195
{
@@ -1220,7 +1220,7 @@ public ReadOnlyCollection<float> GetObservations()
12201220
///
12211221
/// See [Agents - Actions] for more information on masking actions.
12221222
///
1223-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#actions
1223+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#actions
12241224
/// </remarks>
12251225
/// <seealso cref="IActionReceiver.OnActionReceived"/>
12261226
public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
@@ -1296,7 +1296,7 @@ public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
12961296
///
12971297
/// For more information about implementing agent actions see [Agents - Actions].
12981298
///
1299-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_14_docs/docs/Learning-Environment-Design-Agents.md#actions
1299+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Learning-Environment-Design-Agents.md#actions
13001300
/// </remarks>
13011301
/// <param name="actions">
13021302
/// Struct containing the buffers of actions to be executed at this step.

0 commit comments

Comments
 (0)