New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] docstring for SimpleRNNClassifier
#4572
Conversation
signed-off-by: yash sharma <trooper0018080@gmail.com>
Signed-off-by: Yash sharma <trooper0018080@gmail.com>
@fkiraly just a quick question: why do most of Not that it's objectively bad or anything, just asking because of inconsistent (if it matters for docstrings) style from most of other modules. |
Because it has been without maintenance for a period of time - most deep learning estimators lived originally in As content has been migrated to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this looks great!
Could you kindly remove the "should inherited fields" question from the docstring? Sth like this is better asked in the PR thread.
ok I am gonna remove it, thanks for the review |
Signed-off-by: Yash Sharma <trooper0018080@gmail.com>
Signed-off-by: Yash Sharma <trooper0018080@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
now waitasec, I just noticed - and apologies for not noticing earlier - the defaults in the docstring don't actually agree with those in the __init__
!
Can you kindly fix that? Also, where the default is None
(e.g., ,optimizer
), you should check what it is set to internally, e.g., is it Adam
?
oh, sorry for not noticing it from my side too, I'll work on it and update it for the review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed outstanding items for the release
thanks a lot @fkiraly for the fixes, I was indulged in uni exams and thought gonna work on it but you already fixed the docs, Really appreciate it. |
Reference Issues/PRs
Towards #4558
What does this implement/fix? Explain your changes.
Added DocStrings for the
[SimpleRNNClassifier]
(https://github.com/sktime/sktime/blob/main/sktime/classification/deep_learning/rnn.py#L20)