Skip to content

Commit a7e4569

Browse files
Updating release 20 -> release 21 in docs and docstrings.
1 parent 9ff803a commit a7e4569

27 files changed

+75
-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_20_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
35+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
3636
]
3737
},
3838
{
@@ -149,7 +149,7 @@
149149
" import mlagents\n",
150150
" print(\"ml-agents already installed\")\n",
151151
"except ImportError:\n",
152-
" !python -m pip install -q mlagents==0.30.0\n",
152+
" !python -m pip install -q mlagents==1.0.0\n",
153153
" print(\"Installed ml-agents\")"
154154
],
155155
"execution_count": 1,

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_20_docs/docs/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
25+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
2626
]
2727
},
2828
{
@@ -152,7 +152,7 @@
152152
" import mlagents\n",
153153
" print(\"ml-agents already installed\")\n",
154154
"except ImportError:\n",
155-
" !python -m pip install -q mlagents==0.30.0\n",
155+
" !python -m pip install -q mlagents==1.0.0\n",
156156
" print(\"Installed ml-agents\")"
157157
],
158158
"execution_count": 2,
@@ -190,7 +190,7 @@
190190
"id": "pZhVRfdoyPmv"
191191
},
192192
"source": [
193-
"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",
193+
"The [GridWorld](https://github.com/Unity-Technologies/ml-agents/blob/release_21_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",
194194
"\n",
195195
"The observation is an image obtained by a camera on top of the grid.\n",
196196
"\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_20_docs/docs/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
26+
"<img src=\"https://raw.githubusercontent.com/Unity-Technologies/ml-agents/release_21_docs/docs/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
2727
]
2828
},
2929
{
@@ -153,7 +153,7 @@
153153
" import mlagents\n",
154154
" print(\"ml-agents already installed\")\n",
155155
"except ImportError:\n",
156-
" !python -m pip install -q mlagents==0.30.0\n",
156+
" !python -m pip install -q mlagents==1.0.0\n",
157157
" print(\"Installed ml-agents\")"
158158
],
159159
"execution_count": 2,
@@ -176,7 +176,7 @@
176176
"## Side Channel\n",
177177
"\n",
178178
"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",
179-
"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",
179+
"More information available [here](https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/Python-API.md#communicating-additional-information-with-the-environment)\n",
180180
"\n",
181181
"\n",
182182
"\n"
@@ -189,7 +189,7 @@
189189
},
190190
"source": [
191191
"### Engine Configuration SideChannel\n",
192-
"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",
192+
"The [Engine Configuration Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/Python-API.md#engineconfigurationchannel) is used to configure how the Unity Engine should run.\n",
193193
"We will use the GridWorld environment to demonstrate how to use the EngineConfigurationChannel."
194194
]
195195
},
@@ -282,7 +282,7 @@
282282
},
283283
"source": [
284284
"### Environment Parameters Channel\n",
285-
"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",
285+
"The [Environment Parameters Side Channel](https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/Python-API.md#environmentparameters) is used to modify environment parameters during the simulation.\n",
286286
"We will use the GridWorld environment to demonstrate how to use the EngineConfigurationChannel."
287287
]
288288
},
@@ -419,7 +419,7 @@
419419
},
420420
"source": [
421421
"### Creating your own Side Channels\n",
422-
"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"
422+
"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_21_docs/docs/Custom-SideChannels.md#custom-side-channels) for advanced use cases.\n"
423423
]
424424
},
425425
{

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_20_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
10+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/release_21_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.30.0\n",
130+
" !python -m pip install -q mlagents==1.0.0\n",
131131
" print(\"Installed ml-agents\")"
132132
]
133133
},

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_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)
31+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_21_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_21_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_20_docs/docs/images/unity_package_manager_git_url.png)
38+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_21_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_20
42+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_21
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_20",
48+
"com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_21",
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_20_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_21_docs/README.md) contains links for contacting the team or getting support.
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "com.unity.ml-agents.extensions",
33
"displayName": "ML Agents Extensions",
4-
"version": "0.6.1-preview",
4+
"version": "0.6.1-exp.1",
55
"unity": "2022.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.4",
8+
"com.unity.ml-agents": "3.0.0-exp.1",
99
"com.unity.modules.physics": "1.0.0"
1010
}
1111
}

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,28 @@ 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_20_docs/docs/images/unity_package_manager_git_url.png)
64+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/images/unity_package_manager_git_url.png)
6565

6666
In the dialog that appears, enter
6767

6868
```
69-
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_20
69+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_21
7070
```
7171

7272
You can also edit your project's `manifest.json` directly and add the following line to the `dependencies`
7373
section:
7474

7575
```
76-
"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_20",
76+
"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_21",
7777
```
7878

7979
See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this
8080
may take several minutes to resolve the packages the first time that you add it.
8181

8282
#### Local Installation for Development
8383

84-
[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
85-
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_20_docs/docs/Installation.md#advanced-local-installation-for-development-1) directions.
84+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_21_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
85+
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_21_docs/docs/Installation.md#advanced-local-installation-for-development-1) directions.
8686

8787
## Requirements
8888

@@ -154,10 +154,10 @@ Please refer to "Information that is passively collected by Unity" in the
154154
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
155155
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.sentis@latest/index.html
156156
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
157-
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/docs/Installation.md
157+
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_21_docs/docs/Installation.md
158158
[github repository]: https://github.com/Unity-Technologies/ml-agents
159159
[python package]: https://github.com/Unity-Technologies/ml-agents
160160
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html
161161
[connect with us]: https://github.com/Unity-Technologies/ml-agents#community-and-feedback
162162
[ml-agents forum]: https://forum.unity.com/forums/ml-agents.453/
163-
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_20_docs/com.unity.ml-agents.extensions
163+
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_21_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_20_docs/docs/
23+
* https://github.com/Unity-Technologies/ml-agents/tree/release_21_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_20_docs/" +
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_21_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.4";
110+
internal const string k_PackageVersion = "3.0.0-exp.1";
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_20_docs/docs/Learning-Environment-Design-Agents.md#actions
187+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_21_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_20_docs/docs/Learning-Environment-Design-Agents.md#masking-discrete-actions
19+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_21_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)