Skip to content

Updated the release branch docs #3621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 12, 2020
Merged

Updated the release branch docs #3621

merged 2 commits into from
Mar 12, 2020

Conversation

vincentpierre
Copy link
Contributor

Proposed change(s)

Updating the Readme, Changelog and Migrating on the release branch

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

@vincentpierre vincentpierre self-assigned this Mar 12, 2020
surfnerd
surfnerd reviewed Mar 12, 2020
View reviewed changes
README.md Outdated
@@ -3,7 +3,7 @@
<img src="docs/images/image-banner.png" align="middle" width="3000"/>

# Unity ML-Agents Toolkit (Beta)
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/)
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/0.15.0/docs/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this change? I thought we always wanted it to point to latest_release.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when a user goes on the branch with the tag 0.15, the docs should point towards 0.15.
I think we only want to point to latest release on master but on a release branch, we want to point to the release branch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will cause the markdown link check to fail (although only the nightly job checks remote links) since the tag doesn't exist.

surfnerd
surfnerd reviewed Mar 12, 2020
View reviewed changes
README.md
@@ -61,8 +61,8 @@ details of the changes between versions.

| **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) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, why the removal of master (unstable)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for the release branch. II do not think the release branch should point to the moving master/latest_release

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having the "master (unstable)" link should always be there.

Will you change the 0.15.0 -> latest_release link before you actually create the release?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intent when I added this was to only link to previous releases, not master or latest_release

@surfnerd
Copy link
Contributor

not sure why all of the latest_release links were removed. Please change those back to latest_release for the 0.15.0 links. And add back the master (unstable) doc links.

@vincentpierre vincentpierre merged commit 01d5497 into release-0.15.0 Mar 12, 2020
@delete-merged-branch delete-merged-branch bot deleted the release-changelog branch March 12, 2020 22:15
vincentpierre added a commit that referenced this pull request Mar 19, 2020
@vincentpierre
merge release 0.15.0 into master (#3652)
4f12bde 
* Bumping version on the release (#3615)

* Update examples project to 2018.4.18f1 (#3618)

From 2018.4.14f1.  An internal package dependency was updated as
a side effect.

* Remove dead components from the examples scenes (#3619) (#3624)

* Improve warnings and exception if using unsupported combo

* add meta file

* fix unit test

* enforce onnx conversion (expect tf2 CI to fail) (#3600)

* Update error message

* Updated the release branch docs (#3621)

* Updated the release branch docs

* Edited the README

* make sure top-level timer is closed before writing

* Remove space from Product Name for examples

In #2588 it was suggested that the space in the Product Name for
our example environments causes confusion when using a default build
because of the need to escape the space in the build filename.

This change removes the space from the Product Name in the project's
player settings.

* [bug-fix] Increase 3dballhard and GAIL default steps (#3636)

* Updating the NN models (#3632)

* Updating the NN models

* Update gridworld

* [skip ci] Update BallHard

* Update hallway

* [skip ci] Resolve a merging bug

Co-authored-by: Jonathan Harper <jharper+moar@unity3d.com>
Co-authored-by: Chris Elion <chris.elion@unity3d.com>
Co-authored-by: Ervin T <ervin@unity3d.com>
chriselion pushed a commit that referenced this pull request Apr 8, 2020
@vincentpierre @xstreck1
Merge 0.15.1 to master (#3755)
725650f 
* Bumping version on the release (#3615)

* Update examples project to 2018.4.18f1 (#3618)

From 2018.4.14f1.  An internal package dependency was updated as
a side effect.

* Remove dead components from the examples scenes (#3619) (#3624)

* Improve warnings and exception if using unsupported combo

* add meta file

* fix unit test

* enforce onnx conversion (expect tf2 CI to fail) (#3600)

* Update error message

* Updated the release branch docs (#3621)

* Updated the release branch docs

* Edited the README

* make sure top-level timer is closed before writing

* Remove space from Product Name for examples

In #2588 it was suggested that the space in the Product Name for
our example environments causes confusion when using a default build
because of the need to escape the space in the build filename.

This change removes the space from the Product Name in the project's
player settings.

* [bug-fix] Increase 3dballhard and GAIL default steps (#3636)

* Updating the NN models (#3632)

* Updating the NN models

* Update gridworld

* [skip ci] Update BallHard

* Update hallway

* Hotfixes for Release 0.15.1  (#3698)

* [bug-fix] Increase height of wall in CrawlerStatic (#3650)

* [bug-fix] Improve performance for PPO with continuous actions (#3662)

* Corrected a typo in a name of a function (#3670)

OnEpsiodeBegin was corrected to OnEpisodeBegin in Migrating.md document

* Add Academy.AutomaticSteppingEnabled to migration (#3666)

* Fix editor port in Dockerfile (#3674)

* Hotfix memory leak on Python (#3664)

* Hotfix memory leak on Python

* Fixing

* Fixing a bug in the heuristic policy. A decision should not be requested when the agent is done

* [bug-fix] Make Python able to deal with 0-step episodes (#3671)

* adding some comments

Co-authored-by: Ervin T <ervin@unity3d.com>

* Remove vis_encode_type from list of required (#3677)

* Update changelog (#3678)

* Shorten timeout duration for environment close (#3679)

The timeout duration for closing an environment was set to the
same duration as the timeout when waiting for a response from the
still-running environment.  This led to long waits for the error
response when communication version wasn't matching.

This change forces a timeout duration of 0 when handling errors.

* Bumping the versions

* handle multiple dones in a single step (#3700)

* handle multiple dones in a single step

* [tests] Make end-to-end tests more stable (#3697)

* [bug-fix] Fix entropy computation for GaussianDistribution (#3684)

* Fix how we set logging levels (#3703)

* cleanup logging

* comments and cleanup

* pylint, gym

* [skip-ci] Update changelog for logging fix. (#3707)

* [skip ci] Update README

* [skip ci] Fixed a typo

Co-authored-by: Ervin T <ervin@unity3d.com>
Co-authored-by: Adam Streck <adam.streck@gmail.com>
Co-authored-by: Chris Elion <chris.elion@unity3d.com>
Co-authored-by: Jonathan Harper <jharper+moar@unity3d.com>

* fix changelog

* keep master gridworld

Co-authored-by: Vincent-Pierre BERGES <vincentpierre@unity3d.com>
Co-authored-by: Jonathan Harper <jharper+moar@unity3d.com>
Co-authored-by: Ervin T <ervin@unity3d.com>
Co-authored-by: Adam Streck <adam.streck@gmail.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@surfnerd surfnerd surfnerd approved these changes

@chriselion chriselion chriselion approved these changes

@mmattar mmattar Awaiting requested review from mmattar

Assignees

@vincentpierre vincentpierre

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@vincentpierre @surfnerd @chriselion