Skip to content

Conversation

@dongruoping
Copy link
Contributor

Proposed change(s)

Reported in #5380 . We didn't mention the limitation around rendering in the documents and it's not working as expected for users.

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

@dongruoping dongruoping requested a review from vincentpierre May 24, 2021 22:33
be accessed from the `info` provided by `env.step(action)`.
- Stacked vector observations are not supported.
- Environment registration for use with `gym.make()` is currently not supported.
- Display rendering is not supported. Calling `env.render()` might not work as expected in display.
Copy link
Contributor

Choose a reason for hiding this comment

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

It is not true that it is not supported in my opinion. I think we could :

  • remove the env.render() method and then just say "Display rendering is not supported."
  • keep env.render as is and say here : "Calling env.render() will return the latest visual observation. It will not render a new frame of the environment." (also change the docstring on the method.)
  • implement a proper env.render(). This is a lot of work for not a lot of benefit IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For simplicity I prefer not to change/remove the interface now. So I went with second option and updated the doc, let me know what you think.

@dongruoping dongruoping requested a review from vincentpierre May 25, 2021 21:31
Copy link
Contributor

@vincentpierre vincentpierre left a comment

Choose a reason for hiding this comment

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

🚢 🇮🇹

Co-authored-by: Vincent-Pierre BERGES <vincentpierre@unity3d.com>
@dongruoping dongruoping merged commit 56e6d33 into main May 26, 2021
@delete-merged-branch delete-merged-branch bot deleted the develop-gym-render-doc branch May 26, 2021 19:29
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants