Skip to content

Incomplete sentence in installation documentation #5075

@Musubee

Description

@Musubee

Describe the bug
A clear and concise description of what the bug is.

There is an incomplete sentence in the installation docs under the "Clone the ML-Agents Toolkit Repository (Optional)" section:
"The --branch release_14 option will switch to the tag of the latest stable release. Omitting that will get the main branch which is potentially"

I plan to submit a PR to change the Installation.md file, so that the above sentence reads "... which is potentially unstable."

To Reproduce
Steps to reproduce the behavior:

  1. Go to docs/Installation.md
  2. The sentence can be found in the second paragraph of the "Clone the ML-Agents Toolkit Repository (Optional)" section.

Console logs / stack traces
Please wrap in triple backticks (```) to make it easier to read.
N/A

Screenshots
If applicable, add screenshots to help explain your problem.
N/A

Environment (please complete the following information):

  • Unity Version: [e.g. Unity 2020.1f1]
  • OS + version: [e.g. Windows 10]
  • ML-Agents version: (e.g. ML-Agents v0.8, or latest develop branch from source)
  • Torch version: (you can run pip3 show torch to get this)
  • Environment: (which example environment you used to reproduce the error)
    N/A

NOTE: We are unable to help reproduce bugs with custom environments. Please attempt to reproduce your issue with one of the example environments, or provide a minimal patch to one of the environments needed to reproduce the issue.

Metadata

Metadata

Assignees

Labels

bugIssue describes a potential bug in ml-agents.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions