Add warning to academy docs #4226
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vincentpierre
approved these changes
Jul 14, 2020
docs/Learning-Environment-Design.md
Outdated
|
|
||
| In some games, it may be desirable to step the environment with the Academy manually via `Academy.Instance.EnvironmentStep()`. | ||
| If this is the case, be sure `Academy.Instance.EnvironmentStep()` is not called directly or indirectly by the agent's | ||
| `CollectObservations()` function as this will cause an infinite loop that prevents that main Academy update function from being called. |
Contributor
There was a problem hiding this comment.
CollectObservations is not the only method that might pose problems. Anything called BY the EnvironmentStep will be problematic. For example: Heuristic and OnActionReceived.
Contributor
There was a problem hiding this comment.
Would it be better to guard against this? We could do something like
public void EnvironmentStep() {
if(m_Stepping) {
throw new UnityException("Infinite recursion prevented!");
}
m_Stepping = true;
// do all the work
m_Stepping = false;
}
Contributor
Author
There was a problem hiding this comment.
That works for me. It's up to you both.
Contributor
There was a problem hiding this comment.
(with maybe a try/finally around the main body to reset the stepping flag, and/or change the throw to just return)
vincentpierre
approved these changes
Jul 14, 2020
Co-authored-by: Vincent-Pierre BERGES <vincentpierre@unity3d.com>
10 tasks
Contributor
Author
|
Closing because this was made obsolete by #4227 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change(s)
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
#4220
Types of change(s)
Checklist
Other comments