Make ActionSpec ctor public #4896
Merged
Conversation
This file contains 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
chriselion
commented
Jan 29, 2021
| @@ -66,10 +66,17 @@ public static ActionSpec MakeDiscrete(params int[] branchSizes) | |||
| return actuatorSpace; | |||
| } | |||
|
|
|||
| internal ActionSpec(int numContinuousActions, int[] branchSizes = null) | |||
| /// <summary> | |||
| /// Create an ActionSpec initialized with the specified action sizes. | |||
There was a problem hiding this comment.
I would like to propose adding "Writing docstrings for constructors" to the list of "Hard things in Computer Science".
chriselion
commented
Jan 29, 2021
| /// <param name="discreteBranchSizes">The array of branch sizes for the discrete actions. Each index | ||
| /// contains the number of actions available for that branch.</param> | ||
| /// <returns>An ActionSpec initialized with the specified action sizes.</returns> | ||
| public ActionSpec(int numContinuousActions = 0, int[] discreteBranchSizes = null) |
There was a problem hiding this comment.
MakeDiscrete uses the params int[] syntactic sugar, but I feel like adding that here is potentially confusing.
surfnerd
approved these changes
Jan 29, 2021
dongruoping
approved these changes
Jan 29, 2021
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)
We don't currently have any way to create an ActionSpec from code that uses both discrete and continuous actions. This makes the previously internal constructor public, and adds it to the public API test.
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
https://jira.unity3d.com/browse/MLA-1740
Types of change(s)
Checklist