Skip to content

Commit 23aefec

Browse files
authored
Dev rel20 post (#5827)
* update relase tag references * add table in readme (#5816) * nit updates (#5823) * prepare main for dev * update python to v0.31.0-dev0, add unreleased section
1 parent 2335e6f commit 23aefec

30 files changed

+93
-75
lines changed

colab/Colab_UnityEnvironment_1_Run.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
},
3333
"source": [
3434
"# ML-Agents Open a UnityEnvironment\n",
35-
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
35+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
3636
]
3737
},
3838
{
@@ -145,7 +145,7 @@
145145
" import mlagents\n",
146146
" print(\"ml-agents already installed\")\n",
147147
"except ImportError:\n",
148-
" !python -m pip install -q mlagents==0.29.0\n",
148+
" !python -m pip install -q mlagents==0.30.0\n",
149149
" print(\"Installed ml-agents\")"
150150
],
151151
"execution_count": null,

colab/Colab_UnityEnvironment_2_Train.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
},
2323
"source": [
2424
"# ML-Agents Q-Learning with GridWorld\n",
25-
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
25+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
2626
]
2727
},
2828
{
@@ -135,7 +135,7 @@
135135
" import mlagents\n",
136136
" print(\"ml-agents already installed\")\n",
137137
"except ImportError:\n",
138-
" !python -m pip install -q mlagents==0.29.0\n",
138+
" !python -m pip install -q mlagents==0.30.0\n",
139139
" print(\"Installed ml-agents\")"
140140
],
141141
"execution_count": null,
@@ -165,7 +165,7 @@
165165
"id": "pZhVRfdoyPmv"
166166
},
167167
"source": [
168-
"The [GridWorld](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Learning-Environment-Examples.md#gridworld) Environment is a simple Unity visual environment. The Agent is a blue square in a 3x3 grid that is trying to reach a green __`+`__ while avoiding a red __`x`__.\n",
168+
"The [GridWorld](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Learning-Environment-Examples.md#gridworld) Environment is a simple Unity visual environment. The Agent is a blue square in a 3x3 grid that is trying to reach a green __`+`__ while avoiding a red __`x`__.\n",
169169
"\n",
170170
"The observation is an image obtained by a camera on top of the grid.\n",
171171
"\n",

colab/Colab_UnityEnvironment_3_SideChannel.ipynb

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
},
2424
"source": [
2525
"# ML-Agents Use SideChannels\n",
26-
"<img src=\"https://raw.githubusercontent.com/Unity-Technologies/ml-agents/release_19_docs/docs/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
26+
"<img src=\"https://raw.githubusercontent.com/Unity-Technologies/ml-agents/release_20_docs/docs/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
2727
]
2828
},
2929
{
@@ -136,7 +136,7 @@
136136
" import mlagents\n",
137137
" print(\"ml-agents already installed\")\n",
138138
"except ImportError:\n",
139-
" !python -m pip install -q mlagents==0.29.0\n",
139+
" !python -m pip install -q mlagents==0.30.0\n",
140140
" print(\"Installed ml-agents\")"
141141
],
142142
"execution_count": null,
@@ -151,7 +151,7 @@
151151
"## Side Channel\n",
152152
"\n",
153153
"SideChannels are objects that can be passed to the constructor of a UnityEnvironment or the `make()` method of a registry entry to send non Reinforcement Learning related data.\n",
154-
"More information available [here](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Python-API.md#communicating-additional-information-with-the-environment)\n",
154+
"More information available [here](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Python-API.md#communicating-additional-information-with-the-environment)\n",
155155
"\n",
156156
"\n",
157157
"\n"
@@ -164,7 +164,7 @@
164164
},
165165
"source": [
166166
"### Engine Configuration SideChannel\n",
167-
"The [Engine Configuration Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Python-API.md#engineconfigurationchannel) is used to configure how the Unity Engine should run.\n",
167+
"The [Engine Configuration Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Python-API.md#engineconfigurationchannel) is used to configure how the Unity Engine should run.\n",
168168
"We will use the GridWorld environment to demonstrate how to use the EngineConfigurationChannel."
169169
]
170170
},
@@ -216,7 +216,7 @@
216216
},
217217
"source": [
218218
"### Environment Parameters Channel\n",
219-
"The [Environment Parameters Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Python-API.md#environmentparameters) is used to modify environment parameters during the simulation.\n",
219+
"The [Environment Parameters Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Python-API.md#environmentparameters) is used to modify environment parameters during the simulation.\n",
220220
"We will use the GridWorld environment to demonstrate how to use the EngineConfigurationChannel."
221221
]
222222
},
@@ -286,7 +286,7 @@
286286
},
287287
"source": [
288288
"### Creating your own Side Channels\n",
289-
"You can send various kinds of data between a Unity Environment and Python but you will need to [create your own implementation of a Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Custom-SideChannels.md#custom-side-channels) for advanced use cases.\n"
289+
"You can send various kinds of data between a Unity Environment and Python but you will need to [create your own implementation of a Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Custom-SideChannels.md#custom-side-channels) for advanced use cases.\n"
290290
]
291291
}
292292
]

colab/Colab_UnityEnvironment_4_SB3VectorEnv.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"source": [
99
"# ML-Agents run with Stable Baselines 3\n",
10-
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
10+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
1111
]
1212
},
1313
{
@@ -127,7 +127,7 @@
127127
" import mlagents\n",
128128
" print(\"ml-agents already installed\")\n",
129129
"except ImportError:\n",
130-
" !python -m pip install -q mlagents==0.29.0\n",
130+
" !python -m pip install -q mlagents==0.30.0\n",
131131
" print(\"Installed ml-agents\")"
132132
]
133133
},

com.unity.ml-agents.extensions/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
This changelog isn't used; please add to the `com.unity.ml-agents` changelog instead.
33

44
## [Unreleased]
5+
## [0.6.1-preview] - 2022-11-21
56
* Initial version

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,24 @@ 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_19_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_19_docs/docs/Installation.md#advanced-local-installation-for-development-1)
31+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_20_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_20_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/blob/release_19_docs/docs/images/unity_package_manager_git_url.png)
38+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/images/unity_package_manager_git_url.png)
3939

4040
In the dialog that appears, enter
4141
```
42-
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_19
42+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_20
4343
```
4444

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

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"unity": "2021.3",
66
"description": "A source-only package for new features based on ML-Agents",
77
"dependencies": {
8-
"com.unity.ml-agents": "2.3.0-exp.3",
8+
"com.unity.ml-agents": "2.3.0-exp.4",
99
"com.unity.modules.physics": "1.0.0"
1010
}
1111
}

com.unity.ml-agents/CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to
77
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
88

9+
## [Unreleased]
10+
### Major Changes
11+
#### com.unity.ml-agents / com.unity.ml-agents.extensions (C#)
12+
13+
#### ml-agents / ml-agents-envs
14+
15+
### Minor Changes
16+
#### com.unity.ml-agents / com.unity.ml-agents.extensions (C#)
17+
18+
#### ml-agents / ml-agents-envs
19+
20+
### Bug Fixes
21+
#### com.unity.ml-agents / com.unity.ml-agents.extensions (C#)
22+
#### ml-agents / ml-agents-envs
23+
24+
925
## [2.3.0-exp.3] - 2022-11-21
1026
### Major Changes
1127
#### com.unity.ml-agents / com.unity.ml-agents.extensions (C#)

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,25 @@ With the changes to Unity Package Manager in 2021, experimental packages will no
6161

6262
In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL".
6363

64-
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/images/unity_package_manager_git_url.png)
64+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/images/unity_package_manager_git_url.png)
6565

6666
In the dialog that appears, enter
6767
```
68-
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_19
68+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_20
6969
```
7070

7171
You can also edit your project's `manifest.json` directly and add the following line to the `dependencies`
7272
section:
7373
```
74-
"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_19",
74+
"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_20",
7575
```
7676
See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this
7777
may take several minutes to resolve the packages the first time that you add it.
7878

7979
#### Local Installation for Development
8080

81-
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_19_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
82-
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_19_docs/docs/Installation.md#advanced-local-installation-for-development-1)
81+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_20_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
82+
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_20_docs/docs/Installation.md#advanced-local-installation-for-development-1)
8383
directions.
8484

8585
## Requirements
@@ -152,10 +152,10 @@ Please refer to "Information that is passively collected by Unity" in the
152152
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
153153
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
154154
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
155-
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Installation.md
155+
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Installation.md
156156
[github repository]: https://github.com/Unity-Technologies/ml-agents
157157
[python package]: https://github.com/Unity-Technologies/ml-agents
158158
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html
159159
[connect with us]: https://github.com/Unity-Technologies/ml-agents#community-and-feedback
160160
[ml-agents forum]: https://forum.unity.com/forums/ml-agents.453/
161-
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/com.unity.ml-agents.extensions
161+
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/com.unity.ml-agents.extensions

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

+3-3
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_19_docs/docs/
23+
* https://github.com/Unity-Technologies/ml-agents/tree/release_20_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_19_docs/" +
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_20_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 = "2.3.0-exp.3";
110+
internal const string k_PackageVersion = "2.3.0-exp.4";
111111

112112
const int k_EditorTrainingPort = 5004;
113113

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ public interface IActionReceiver
184184
///
185185
/// See [Agents - Actions] for more information on masking actions.
186186
///
187-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Learning-Environment-Design-Agents.md#actions
187+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Learning-Environment-Design-Agents.md#actions
188188
/// </remarks>
189189
/// <seealso cref="IActionReceiver.OnActionReceived"/>
190190
void WriteDiscreteActionMask(IDiscreteActionMask actionMask);

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public interface IDiscreteActionMask
1616
///
1717
/// See [Agents - Actions] for more information on masking actions.
1818
///
19-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_19_docs/docs/Learning-Environment-Design-Agents.md#masking-discrete-actions
19+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Learning-Environment-Design-Agents.md#masking-discrete-actions
2020
/// </remarks>
2121
/// <param name="branch">The branch for which the actions will be masked.</param>
2222
/// <param name="actionIndex">Index of the action.</param>

0 commit comments

Comments
 (0)