Skip to content

Commit 6a140f6

Browse files
author
Chris Elion
authored
R12 update docs tags (#4795)
* update package version and release tag, update doc links * changelog * table
1 parent 6d12a47 commit 6a140f6

File tree

22 files changed

+54
-45
lines changed

22 files changed

+54
-45
lines changed

README.md

Lines changed: 5 additions & 4 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_11_docs/docs/)
5+
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_12_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 11`. Click
52-
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/docs/Readme.md)
51+
**Our latest, stable release is `Release 12`. Click
52+
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_12_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,7 +67,8 @@ 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 11** | **December 21, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_11)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_11.zip)** |
70+
| **Release 12** | **December 22, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_12)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_12.zip)** |
71+
| **Release 11** | December 21, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_11) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_11.zip) |
7172
| **Release 10** | November 18, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_10) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_10_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_10.zip) |
7273
| **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) |
7374
| **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) |

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

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

3737
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).
3838

39-
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_11_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development.
39+
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_12_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development.
4040

4141
The Food Collector environment can be described as:
4242
* 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_11_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_12_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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ The ML-Agents Extensions package is not currently available in the Package Manag
2828
recommended ways to install the package:
2929

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

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

38-
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/docs/images/unity_package_manager_git_url.png)
38+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/images/unity_package_manager_git_url.png)
3939
In the dialog that appears, enter
4040
```
4141
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions
@@ -60,4 +60,4 @@ following versions of the Unity Editor:
6060
none
6161

6262
## Need Help?
63-
The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/README.md) contains links for contacting the team or getting support.
63+
The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/README.md) contains links for contacting the team or getting support.

com.unity.ml-agents.extensions/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
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.7.0-preview"
8+
"com.unity.ml-agents": "1.7.1-preview"
99
}
1010
}

com.unity.ml-agents/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to
77
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
88

99

10+
## [1.7.1-preview] - 2020-12-21
11+
### Bug Fixes
12+
#### com.unity.ml-agents (C#)
13+
- Add analytics package dependency to the package manifest. (#4794)
14+
1015
## [1.7.0-preview] - 2020-12-21
1116
### Major Changes
1217
#### com.unity.ml-agents (C#)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Please refer to "Information that is passively collected by Unity" in the
118118
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
119119
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
120120
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
121-
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_11_docs/docs/Installation.md
121+
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Installation.md
122122
[github repository]: https://github.com/Unity-Technologies/ml-agents
123123
[python package]: https://github.com/Unity-Technologies/ml-agents
124124
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html

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_11_docs/docs/
23+
* https://github.com/Unity-Technologies/ml-agents/tree/release_12_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_11_docs/" +
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/" +
6565
"docs/Learning-Environment-Design.md")]
6666
public class Academy : IDisposable
6767
{
@@ -99,7 +99,7 @@ public class Academy : IDisposable
9999
/// Unity package version of com.unity.ml-agents.
100100
/// This must match the version string in package.json and is checked in a unit test.
101101
/// </summary>
102-
internal const string k_PackageVersion = "1.7.0-preview";
102+
internal const string k_PackageVersion = "1.7.1-preview";
103103

104104
const int k_EditorTrainingPort = 5004;
105105

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_11_docs/docs/Learning-Environment-Design-Agents.md#actions
221+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_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_11_docs/docs/Learning-Environment-Design-Agents.md#actions
20+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_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>

0 commit comments

Comments
 (0)