[MRG] DOC Fix incorrect documented output shape for predict
method of linear models when n_targets > 1
#29026
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
Fixes #29009.
What does this implement/fix? Explain your changes.
This fix updates the documentation of the
predict
method of all linear models which support multiple output/targets to account for the possibility of having a return value with shape(n_samples, n_targets)
rather than(n_samples,)
. To do this, all classes which subclass bothLinearModel
andMultiOutputMixin
now instead subclass a new classMultiOutputLinearModel
(which itself subclasses bothLinearModel
andMultiOutputMixin
) that has apredict
method with the correct documentation.Any other comments?
This is my first pull request, so apologies in advance for any mistakes throughout this process.