Skip to content

Commit 5355595

Browse files
committed
Update documentation links
1 parent f4c6056 commit 5355595

File tree

9 files changed

+30
-30
lines changed

9 files changed

+30
-30
lines changed

colab/Colab_UnityEnvironment_1_Run.ipynb

Lines changed: 1 addition & 1 deletion
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_23_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
35+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
3636
]
3737
},
3838
{

colab/Colab_UnityEnvironment_2_Train.ipynb

Lines changed: 2 additions & 2 deletions
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_23_docs/docs/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
25+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/images/gridworld.png?raw=true\" align=\"middle\" width=\"435\"/>"
2626
]
2727
},
2828
{
@@ -190,7 +190,7 @@
190190
"id": "pZhVRfdoyPmv"
191191
},
192192
"source": [
193-
"The [GridWorld](https://github.com/Unity-Technologies/ml-agents/blob/release_23_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/develop/com.unity.ml-agents/Documentation~/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

Lines changed: 5 additions & 5 deletions
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_23_docs/docs/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
26+
"<img src=\"https://raw.githubusercontent.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/images/3dball_big.png\" align=\"middle\" width=\"435\"/>"
2727
]
2828
},
2929
{
@@ -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_23_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/develop/com.unity.ml-agents/Documentation~/Python-LLAPI.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_23_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/develop/com.unity.ml-agents/Documentation~/Python-LLAPI.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_23_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/develop/com.unity.ml-agents/Documentation~/Python-LLAPI.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_23_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/develop/com.unity.ml-agents/Documentation~/Custom-SideChannels.md#custom-side-channels) for advanced use cases.\n"
423423
]
424424
},
425425
{

colab/Colab_UnityEnvironment_4_SB3VectorEnv.ipynb

Lines changed: 1 addition & 1 deletion
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_23_docs/docs/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
10+
"<img src=\"https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/images/image-banner.png?raw=true\" align=\"middle\" width=\"435\"/>"
1111
]
1212
},
1313
{

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
* manages the communication between the learning environment and the Python
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
22-
* Unity scene, please browse our documentation pages on GitHub:
23-
* https://github.com/Unity-Technologies/ml-agents/tree/release_23_docs/docs/
22+
* Unity scene, please browse our documentation pages:
23+
* https://docs.unity3d.com/Packages/com.unity.ml-agents@latest
2424
*/
2525

2626
namespace Unity.MLAgents
@@ -61,8 +61,8 @@ 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_23_docs/" +
65-
"docs/Learning-Environment-Design.md")]
64+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/" +
65+
"Documentation~/Learning-Environment-Design.md")]
6666
public class Academy : IDisposable
6767
{
6868
/// <summary>

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

Lines changed: 1 addition & 1 deletion
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_23_docs/docs/Learning-Environment-Design-Agents.md#actions
187+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~//Learning-Environment-Design-Agents.md
188188
/// </remarks>
189189
/// <seealso cref="IActionReceiver.OnActionReceived"/>
190190
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
@@ -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_23_docs/docs/Learning-Environment-Design-Agents.md#masking-discrete-actions
19+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/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>

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -192,14 +192,14 @@ public override BuiltInActuatorType GetBuiltInActuatorType()
192192
/// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html]
193193
/// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html
194194
/// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html
195-
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md
196-
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design.md
195+
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md
196+
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design.md
197197
/// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
198-
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Readme.md
198+
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/index.md
199199
///
200200
/// </remarks>
201-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/" +
202-
"docs/Learning-Environment-Design-Agents.md")]
201+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/" +
202+
"Documentation~/Learning-Environment-Design-Agents.md")]
203203
[Serializable]
204204
[RequireComponent(typeof(BehaviorParameters))]
205205
[DefaultExecutionOrder(-50)]
@@ -728,8 +728,8 @@ public int CompletedEpisodes
728728
/// for information about mixing reward signals from curiosity and Generative Adversarial
729729
/// Imitation Learning (GAIL) with rewards supplied through this method.
730730
///
731-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#rewards
732-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
731+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob//Learning-Environment-Design-Agents.md#rewards
732+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/ML-Agents-Overview.md#a-quick-note-on-reward-signals
733733
/// </remarks>
734734
/// <param name="reward">The new value of the reward.</param>
735735
public void SetReward(float reward)
@@ -756,8 +756,8 @@ public void SetReward(float reward)
756756
/// for information about mixing reward signals from curiosity and Generative Adversarial
757757
/// Imitation Learning (GAIL) with rewards supplied through this method.
758758
///
759-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#rewards
760-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
759+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#rewards
760+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/ML-Agents-Overview.md#a-quick-note-on-reward-signals
761761
///</remarks>
762762
/// <param name="increment">Incremental reward value.</param>
763763
public void AddReward(float increment)
@@ -945,8 +945,8 @@ public virtual void Initialize() { }
945945
/// implementing a simple heuristic function can aid in debugging agent actions and interactions
946946
/// with its environment.
947947
///
948-
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
949-
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#actions
948+
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#recording-demonstrations
949+
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#actions
950950
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
951951
/// </remarks>
952952
/// <example>
@@ -1203,7 +1203,7 @@ void ResetSensors()
12031203
/// For more information about observations, see [Observations and Sensors].
12041204
///
12051205
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
1206-
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
1206+
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#observations-and-sensors
12071207
/// </remarks>
12081208
public virtual void CollectObservations(VectorSensor sensor)
12091209
{
@@ -1245,7 +1245,7 @@ public ReadOnlyCollection<float> GetStackedObservations()
12451245
///
12461246
/// See [Agents - Actions] for more information on masking actions.
12471247
///
1248-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#actions
1248+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#actions
12491249
/// </remarks>
12501250
/// <seealso cref="IActionReceiver.OnActionReceived"/>
12511251
public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask) { }
@@ -1312,7 +1312,7 @@ public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask) { }
13121312
///
13131313
/// For more information about implementing agent actions see [Agents - Actions].
13141314
///
1315-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_23_docs/docs/Learning-Environment-Design-Agents.md#actions
1315+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#actions
13161316
/// </para>
13171317
/// </remarks>
13181318
/// <param name="actions">

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_23_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations
22+
/// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/develop/com.unity.ml-agents/Documentation~/Learning-Environment-Design-Agents.md#recording-demonstrations
2323
/// </remarks>
2424
[RequireComponent(typeof(Agent))]
2525
[AddComponentMenu("ML Agents/Demonstration Recorder", (int)MenuGroup.Default)]

0 commit comments

Comments
 (0)