DOC fit_ and partial_fit_ documentation for class Birch #18796
Conversation
|
ping @adrinjalali |
| fit_ : bool | ||
| True if `fit` method is called. | ||
| partial_fit_ : bool | ||
| True if `partial_fit` method is called. | ||
There was a problem hiding this comment.
I'd say we can make these private probably, @ogrisel do you happen to know if we need to keep these two as public?
There was a problem hiding this comment.
They are clearly for internal purpose only. We should make them private indeed
There was a problem hiding this comment.
So do we deprecate their usage while documenting for 2 versions or we just switch to only making them private?
There was a problem hiding this comment.
As much as I would love to just make them private, I think we need to follow the deprecation period.
There was a problem hiding this comment.
Usually we do not document deprecated features in the public docstrings. So I would rather be in favor of closing this doc PR and just merging the deprecation PR: #19297 instead.
jeremiedbb
left a comment
There was a problem hiding this comment.
lgtm.
(the deprecation is being done in #19297)
|
I agree, we don't need to update the docstrings for the deprecated ones. Thanks for the work though @marenwestermann |
Reference Issues/PRs
References #14312
What does this implement/fix? Explain your changes.
Documents the attributes
fit_andpartial_fit_in class BirchAny other comments?