Skip to content

Commit 2a2be32

Browse files
xiaomaogyErvin Teng
authored andcommitted
Replaced all of the doc to release_3_doc
1 parent 1dc4972 commit 2a2be32

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* API. For more information on each of these entities, in addition to how to
2020
* set-up a learning environment and train the behavior of characters in a
2121
* Unity scene, please browse our documentation pages on GitHub:
22-
* https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/
22+
* https://github.com/Unity-Technologies/ml-agents/tree/release_3_docs/docs/
2323
*/
2424

2525
namespace Unity.MLAgents
@@ -51,7 +51,7 @@ void FixedUpdate()
5151
/// fall back to inference or heuristic decisions. (You can also set agents to always use
5252
/// inference or heuristics.)
5353
/// </remarks>
54-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/" +
54+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_3_docs/" +
5555
"docs/Learning-Environment-Design.md")]
5656
public class Academy : IDisposable
5757
{

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,13 @@ internal struct AgentAction
145145
/// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html]
146146
/// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html
147147
/// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html
148-
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md
149-
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design.md
148+
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md
149+
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design.md
150150
/// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
151-
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Readme.md
151+
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Readme.md
152152
///
153153
/// </remarks>
154-
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/" +
154+
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/" +
155155
"docs/Learning-Environment-Design-Agents.md")]
156156
[Serializable]
157157
[RequireComponent(typeof(BehaviorParameters))]
@@ -603,8 +603,8 @@ public int CompletedEpisodes
603603
/// for information about mixing reward signals from curiosity and Generative Adversarial
604604
/// Imitation Learning (GAIL) with rewards supplied through this method.
605605
///
606-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#rewards
607-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
606+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#rewards
607+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
608608
/// </remarks>
609609
/// <param name="reward">The new value of the reward.</param>
610610
public void SetReward(float reward)
@@ -633,8 +633,8 @@ public void SetReward(float reward)
633633
/// for information about mixing reward signals from curiosity and Generative Adversarial
634634
/// Imitation Learning (GAIL) with rewards supplied through this method.
635635
///
636-
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#rewards
637-
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
636+
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#rewards
637+
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
638638
///</remarks>
639639
/// <param name="increment">Incremental reward value.</param>
640640
public void AddReward(float increment)
@@ -786,8 +786,8 @@ public virtual void Initialize() {}
786786
/// implementing a simple heuristic function can aid in debugging agent actions and interactions
787787
/// with its environment.
788788
///
789-
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
790-
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions
789+
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
790+
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#actions
791791
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
792792
/// </remarks>
793793
/// <example>
@@ -989,7 +989,7 @@ void ResetSensors()
989989
/// For more information about observations, see [Observations and Sensors].
990990
///
991991
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
992-
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
992+
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
993993
/// </remarks>
994994
public virtual void CollectObservations(VectorSensor sensor)
995995
{
@@ -1020,7 +1020,7 @@ public ReadOnlyCollection<float> GetObservations()
10201020
///
10211021
/// See [Agents - Actions] for more information on masking actions.
10221022
///
1023-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions
1023+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#actions
10241024
/// </remarks>
10251025
/// <seealso cref="OnActionReceived(float[])"/>
10261026
public virtual void CollectDiscreteActionMasks(DiscreteActionMasker actionMasker)
@@ -1090,7 +1090,7 @@ public virtual void CollectDiscreteActionMasks(DiscreteActionMasker actionMasker
10901090
///
10911091
/// For more information about implementing agent actions see [Agents - Actions].
10921092
///
1093-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions
1093+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#actions
10941094
/// </remarks>
10951095
/// <param name="vectorAction">
10961096
/// An array containing the action vector. The length of the array is specified

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ internal DiscreteActionMasker(BrainParameters brainParameters)
4040
///
4141
/// See [Agents - Actions] for more information on masking actions.
4242
///
43-
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions
43+
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_3_docs/docs/Learning-Environment-Design-Agents.md#actions
4444
/// </remarks>
4545
/// <param name="branch">The branch for which the actions will be masked.</param>
4646
/// <param name="actionIndices">The indices of the masked actions.</param>

0 commit comments

Comments
 (0)