[DOC] added docstring to the HierarchicalDask class
#7684
Conversation
There was a problem hiding this comment.
Thanks, good start!
The index convention is not correct, dask frames do not have an index. Instead, the index columns are encoded using a specific schema, which should be described here.
I recommend you use get_examples to generate some examples for the data type, which should highlight the condition. Alternatively, the _check method has the exact conditions as code. Please let us know if you would like more explanation.
PS: once you have figured it out, PanelDask has a very similar description.
|
hello @fkiraly , sorry about late response to the review, was busy with a few things. i have made the changes requested and have used the |
There was a problem hiding this comment.
Thanks!
- Can you ensure that code formatting checks pass? https://www.sktime.net/en/stable/developer_guide/coding_standards.html
- can you check whether the index columns need to have a specific naming convention to them?
|
Thanks for the feedback.
|
|
@fkiraly I have added information regarding the column naming convention to the docstring. I decided not to add a Methods section as none of the other docstrings for other such classes had this section. |
There was a problem hiding this comment.
Nice! This is great!
Only minor change requests:
- ensure the code formatting is as per the precommit. You added too many newlines and this will fail the CI.
- the bullet point lists need to be preceded and succeeded by newlines to render correctly. See the readthedocs build for how it looks like.
|
i have made the requested changes, hope they pass the tests now |
#### Reference Issues/PRs Towards fixing issue sktime#7386 #### What does this implement/fix? Explain your changes. Implements a docstring for the HierarchicalDask class.
Reference Issues/PRs
Towards fixing issue #7386
What does this implement/fix? Explain your changes.
Implements a docstring for the HierarchicalDask class.
Does your contribution introduce a new dependency? If yes, which one?
None
What should a reviewer concentrate their feedback on?
Did you add any tests for the change?
No, it is not required.
Any other comments?
PR checklist
For all contributions
How to: add yourself to the all-contributors file in the
sktimeroot directory (not theCONTRIBUTORS.md). Common badges:code- fixing a bug, or adding code logic.doc- writing or improving documentation or docstrings.bug- reporting or diagnosing a bug (get this pluscodeif you also fixed the bug in the PR).maintenance- CI, test framework, release.See here for full badge reference
maintainerstag - do this if you want to become the owner or maintainer of an estimator you added.See here for further details on the algorithm maintainer role.
For new estimators
docs/source/api_reference/taskname.rst, follow the pattern.Examplessection.python_dependenciestag and ensureddependency isolation, see the estimator dependencies guide.