Update release_9 versions (#4621)
This commit is contained in:
Ruo-Ping (Rachel) Dong
GitHub
Родитель
79faafdb43
Коммит
0b32bd4fa3
10
README.md
10
README.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
# Unity ML-Agents Toolkit
|
||||
|
||||
[](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/)
|
||||
[](https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/)
|
||||
|
||||
[](LICENSE)
|
||||
|
||||
|
|
@ -48,8 +48,8 @@ descriptions of all these features.
|
|||
|
||||
## Releases & Documentation
|
||||
|
||||
**Our latest, stable release is `Release 8`. Click
|
||||
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/Readme.md)
|
||||
**Our latest, stable release is `Release 9`. Click
|
||||
[here](https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/Readme.md)
|
||||
to get started with the latest release of ML-Agents.**
|
||||
|
||||
The table below lists all our releases, including our `master` branch which is
|
||||
|
|
@ -67,13 +67,13 @@ under active development and may be unstable. A few helpful guidelines:
|
|||
| **Version** | **Release Date** | **Source** | **Documentation** | **Download** |
|
||||
|:-------:|:------:|:-------------:|:-------:|:------------:|
|
||||
| **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) |
|
||||
| **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)** |
|
||||
| **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)** |
|
||||
| **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) |
|
||||
| **Release 7** | September 16, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_7) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_7_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_7.zip) |
|
||||
| **Release 6** | August 12, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_6) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_6_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_6.zip) |
|
||||
| **Release 5** | July 31, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_5) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_5_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_5.zip) |
|
||||
| **Release 4** | July 15, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_4) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_4_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_4.zip) |
|
||||
| **Release 3** | June 10, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_3) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_3_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_3.zip) |
|
||||
| **Release 2** | May 20, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_2) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_2.zip) |
|
||||
|
||||
## Citation
|
||||
|
||||
|
|
|
|||
|
|
@ -114,7 +114,7 @@ a number of ways to [connect with us] including our [ML-Agents Forum].
|
|||
[unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
|
||||
[unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
|
||||
[package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html
|
||||
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Installation.md
|
||||
[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Installation.md
|
||||
[github repository]: https://github.com/Unity-Technologies/ml-agents
|
||||
[python package]: https://github.com/Unity-Technologies/ml-agents
|
||||
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ using Unity.Barracuda;
|
|||
* API. For more information on each of these entities, in addition to how to
|
||||
* set-up a learning environment and train the behavior of characters in a
|
||||
* Unity scene, please browse our documentation pages on GitHub:
|
||||
* https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/docs/
|
||||
* https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/docs/
|
||||
*/
|
||||
|
||||
namespace Unity.MLAgents
|
||||
|
|
@ -61,7 +61,7 @@ namespace Unity.MLAgents
|
|||
/// fall back to inference or heuristic decisions. (You can also set agents to always use
|
||||
/// inference or heuristics.)
|
||||
/// </remarks>
|
||||
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_8_docs/" +
|
||||
[HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_9_docs/" +
|
||||
"docs/Learning-Environment-Design.md")]
|
||||
public class Academy : IDisposable
|
||||
{
|
||||
|
|
|
|||
|
|
@ -160,7 +160,7 @@ namespace Unity.MLAgents.Actuators
|
|||
///
|
||||
/// See [Agents - Actions] for more information on masking actions.
|
||||
///
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// </remarks>
|
||||
/// <seealso cref="IActionReceiver.OnActionReceived"/>
|
||||
void WriteDiscreteActionMask(IDiscreteActionMask actionMask);
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ namespace Unity.MLAgents.Actuators
|
|||
///
|
||||
/// See [Agents - Actions] for more information on masking actions.
|
||||
///
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// </remarks>
|
||||
/// <param name="branch">The branch for which the actions will be masked.</param>
|
||||
/// <param name="actionIndices">The indices of the masked actions.</param>
|
||||
|
|
|
|||
|
|
@ -148,13 +148,13 @@ namespace Unity.MLAgents
|
|||
/// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html]
|
||||
/// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html
|
||||
/// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html
|
||||
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md
|
||||
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design.md
|
||||
/// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md
|
||||
/// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design.md
|
||||
/// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
|
||||
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Readme.md
|
||||
/// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Readme.md
|
||||
///
|
||||
/// </remarks>
|
||||
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/" +
|
||||
[HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/" +
|
||||
"docs/Learning-Environment-Design-Agents.md")]
|
||||
[Serializable]
|
||||
[RequireComponent(typeof(BehaviorParameters))]
|
||||
|
|
@ -630,8 +630,8 @@ namespace Unity.MLAgents
|
|||
/// for information about mixing reward signals from curiosity and Generative Adversarial
|
||||
/// Imitation Learning (GAIL) with rewards supplied through this method.
|
||||
///
|
||||
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#rewards
|
||||
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
|
||||
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#rewards
|
||||
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
|
||||
/// </remarks>
|
||||
/// <param name="reward">The new value of the reward.</param>
|
||||
public void SetReward(float reward)
|
||||
|
|
@ -660,8 +660,8 @@ namespace Unity.MLAgents
|
|||
/// for information about mixing reward signals from curiosity and Generative Adversarial
|
||||
/// Imitation Learning (GAIL) with rewards supplied through this method.
|
||||
///
|
||||
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#rewards
|
||||
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
|
||||
/// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#rewards
|
||||
/// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals
|
||||
///</remarks>
|
||||
/// <param name="increment">Incremental reward value.</param>
|
||||
public void AddReward(float increment)
|
||||
|
|
@ -839,8 +839,8 @@ namespace Unity.MLAgents
|
|||
/// implementing a simple heuristic function can aid in debugging agent actions and interactions
|
||||
/// with its environment.
|
||||
///
|
||||
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
|
||||
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations
|
||||
/// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
|
|
@ -1087,7 +1087,7 @@ namespace Unity.MLAgents
|
|||
/// For more information about observations, see [Observations and Sensors].
|
||||
///
|
||||
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
|
||||
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
|
||||
/// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors
|
||||
/// </remarks>
|
||||
public virtual void CollectObservations(VectorSensor sensor)
|
||||
{
|
||||
|
|
@ -1118,7 +1118,7 @@ namespace Unity.MLAgents
|
|||
///
|
||||
/// See [Agents - Actions] for more information on masking actions.
|
||||
///
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// </remarks>
|
||||
/// <seealso cref="IActionReceiver.OnActionReceived"/>
|
||||
public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
|
||||
|
|
@ -1193,7 +1193,7 @@ namespace Unity.MLAgents
|
|||
///
|
||||
/// For more information about implementing agent actions see [Agents - Actions].
|
||||
///
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// </remarks>
|
||||
/// <param name="actions">
|
||||
/// Struct containing the buffers of actions to be executed at this step.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ namespace Unity.MLAgents.Demonstrations
|
|||
/// See [Imitation Learning - Recording Demonstrations] for more information.
|
||||
///
|
||||
/// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
|
||||
/// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations
|
||||
/// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations
|
||||
/// </remarks>
|
||||
[RequireComponent(typeof(Agent))]
|
||||
[AddComponentMenu("ML Agents/Demonstration Recorder", (int)MenuGroup.Default)]
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ namespace Unity.MLAgents
|
|||
///
|
||||
/// See [Agents - Actions] for more information on masking actions.
|
||||
///
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/docs/Learning-Environment-Design-Agents.md#actions
|
||||
/// </remarks>
|
||||
/// <param name="branch">The branch for which the actions will be masked.</param>
|
||||
/// <param name="actionIndices">The indices of the masked actions.</param>
|
||||
|
|
|
|||
|
|
@ -123,10 +123,10 @@ commands in an Anaconda Prompt _(if you open a new prompt, be sure to activate
|
|||
the ml-agents Conda environment by typing `activate ml-agents`)_:
|
||||
|
||||
```sh
|
||||
git clone --branch release_8 https://github.com/Unity-Technologies/ml-agents.git
|
||||
git clone --branch release_9 https://github.com/Unity-Technologies/ml-agents.git
|
||||
```
|
||||
|
||||
The `--branch release_8` option will switch to the tag of the latest stable
|
||||
The `--branch release_9` option will switch to the tag of the latest stable
|
||||
release. Omitting that will get the `master` branch which is potentially
|
||||
unstable.
|
||||
|
||||
|
|
|
|||
|
|
@ -58,10 +58,10 @@ example environments and training configurations to experiment with them (some
|
|||
of our tutorials / guides assume you have access to our example environments).
|
||||
|
||||
```sh
|
||||
git clone --branch release_8 https://github.com/Unity-Technologies/ml-agents.git
|
||||
git clone --branch release_9 https://github.com/Unity-Technologies/ml-agents.git
|
||||
```
|
||||
|
||||
The `--branch release_8` option will switch to the tag of the latest stable
|
||||
The `--branch release_9` option will switch to the tag of the latest stable
|
||||
release. Omitting that will get the `master` branch which is potentially
|
||||
unstable.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ unstable.
|
|||
|
||||
You will need to clone the repository if you plan to modify or extend the
|
||||
ML-Agents Toolkit for your purposes. If you plan to contribute those changes
|
||||
back, make sure to clone the `master` branch (by omitting `--branch release_8`
|
||||
back, make sure to clone the `master` branch (by omitting `--branch release_9`
|
||||
from the command above). See our
|
||||
[Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more
|
||||
information on contributing to the ML-Agents Toolkit.
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ After launching your EC2 instance using the ami and ssh into it:
|
|||
2. Clone the ML-Agents repo and install the required Python packages
|
||||
|
||||
```sh
|
||||
git clone --branch release_8 https://github.com/Unity-Technologies/ml-agents.git
|
||||
git clone --branch release_9 https://github.com/Unity-Technologies/ml-agents.git
|
||||
cd ml-agents/ml-agents/
|
||||
pip3 install -e .
|
||||
```
|
||||
|
|
|
|||
|
|
@ -49,9 +49,9 @@ The ML-Agents Toolkit only supports the models created with our trainers. Model
|
|||
loading expects certain conventions for constants and tensor names. While it is
|
||||
possible to construct a model that follows these conventions, we don't provide
|
||||
any additional help for this. More details can be found in
|
||||
[TensorNames.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs)
|
||||
[TensorNames.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs)
|
||||
and
|
||||
[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_8_docs/com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs).
|
||||
[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_9_docs/com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs).
|
||||
|
||||
If you wish to run inference on an externally trained model, you should use
|
||||
Barracuda directly, instead of trying to run it through ML-Agents.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Version of the library that will be used to upload to pypi
|
||||
__version__ = "0.21.0"
|
||||
__version__ = "0.21.1"
|
||||
|
||||
# Git tag that will be checked to determine whether to trigger upload to pypi
|
||||
__release_tag__ = "release_8"
|
||||
__release_tag__ = "release_9"
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Version of the library that will be used to upload to pypi
|
||||
__version__ = "0.21.0"
|
||||
__version__ = "0.21.1"
|
||||
|
||||
# Git tag that will be checked to determine whether to trigger upload to pypi
|
||||
__release_tag__ = "release_8"
|
||||
__release_tag__ = "release_9"
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Version of the library that will be used to upload to pypi
|
||||
__version__ = "0.21.0"
|
||||
__version__ = "0.21.1"
|
||||
|
||||
# Git tag that will be checked to determine whether to trigger upload to pypi
|
||||
__release_tag__ = "release_8"
|
||||
__release_tag__ = "release_9"
|
||||
|
|
|
|||
|
|
@ -74,6 +74,7 @@ versions = [
|
|||
ReleaseInfo("release_6", "1.3.0", "0.19.0", "August 12, 2020"),
|
||||
ReleaseInfo("release_7", "1.4.0", "0.20.0", "September 16, 2020"),
|
||||
ReleaseInfo("release_8", "1.5.0", "0.21.0", "October 14, 2020"),
|
||||
ReleaseInfo("release_9", "1.5.0", "0.21.1", "November 4, 2020"),
|
||||
]
|
||||
|
||||
MAX_DAYS = 150 # do not print releases older than this many days
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче