Add a note on Custom messages about needing trainer changes #2534
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
awjuliani
reviewed
Sep 11, 2019
There was a problem hiding this comment.
Thanks for adding this Chris. I think it would be best to modify the messaging a little bit to say that this feature is meant for researchers who intent to use the resulting environments with their own training code. Along with that we can say that we don't recommend modifying our trainer code, or using this feature unless you know what you are doing and have a very specific use-case in mind (which the bulk of your text here clearly captures).
|
Thanks @awjuliani, I added some of your comments to the disclaimer. Let me know what you think. |
surfnerd
pushed a commit
that referenced
this pull request
Sep 12, 2019
* Add a note on Custom messages about needing trainer changes * move to top (aside doesn't render as expected) * Don't blockquote * Update wording
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.
Followup from in-person discussion. The current documentation undersells the amount of effort needed to get Custom* working.