DOC Remove extra documentation of t_ for MLPRegressor #19805
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
thomasjpfan
reviewed
Apr 1, 2021
| @@ -1320,10 +1320,6 @@ class MLPRegressor(RegressorMixin, BaseMultilayerPerceptron): | |||
| loss_curve_ : list of shape (n_iters,) | |||
| Loss value evaluated at the end of each training step. | |||
|
|
|||
| t_ : int | |||
| Mathematically equals `n_iters * X.shape[0]`, it means | |||
| `time_step` and it is used by optimizer's learning rate scheduler. | |||
There was a problem hiding this comment.
I think n_iters * X.shapes[0] part is useful information. Can we update the t_ : above to include this information:
t_ : int
The number of training samples seen by the solver during fitting.
Same as `n_iter_ * n_samples`.
Closed
|
OK I got confused. #19595 solve the issue and was already merged. Sorry for the noise. Closing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference Issues/PRs
Addresses #19804
What does this implement/fix? Explain your changes.
The
t_attribute was documented twice inMLPRegressor. This removes the second documentation instance (based on theMLPClassifierdocumentation and experimentation showing that the attribute doesn't contain what that documentation said it does).