-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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] move content from pydata global 2022 (transformers, pipelines tutorial) to sktime main repo #4381
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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 a lot, much appreciated!
- the notebooks should be linted, the linter is complaining... you can see the issues when going on "details" next to the failing check
- have you checked whether there is content in one that's not there in the other, perhaps it makes sense to keep parts of the original notebook? I'm not sure myself, your opinion is appreciated.
Thanks, @fkiraly. I will resolve it during the weekend. |
thanks! as said, would be interested in your opinion more generally, which material and which order of material is most useful to readers looking for a tutorial. |
Hi @fkiraly, sorry for taking a while. The biggest part of them is equal or almost equal: What are transformers, Different types of transformers, Broadcasting, Transformers as pipeline components, Searching for transformers. What is different: the existing notebook contains a big section 'Transformers types and signatures' IMHO there are two options:
Let me know which one would be better to choose. PS. regarding the pipelines notebook - I believe it could fit logically well as number 5 into examples (after benchmarking) |
No worries, and thanks a lot for having a look! I would go with option 1 in order to not lose content. My further recommendations would be based on these high-level principles:
So, based on what you say, it seems the following would make sense?
Questions:
For the pipelines notebook, I would actually put it after transformers but before benchmarking - because of the "conditionality" in the sense that you need transformers to build pipelines, and you want to benchmark any kind of estimators (including pipelines). |
Hi @fkiraly, Thanks for the detailed response. I also agree with this:
Regarding the question
I would say that the proposed structure is fine. The only possible question I have is about cheat sheets (they are the part of 2.4 Appendix of pydata transformers). I am not sure what is the best place for them. On the one hand, it is good to have consolidated information after the concept studying (so placing them in Appendix is fine). On the other hand, typically cheat sheets are frequently used, so maybe moving them higher (before the intro part) and placing them as part 0 would be a better option. Let me know what are your thoughts on that. |
Hmm - I see the point! The drawback of part 0 would be, the "new user" reader who expected a gradual introduction instead sees a summary of content they haven't seen yet. How about moving the cheat sheet/notebook to a separate file, e.g., |
Hi @dashapetr, how is this going? Are you still working on this? Would you like some input or help? |
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.
changes were made according to the discussion
Hi @fkiraly, I am so sorry for taking so long to proceed. I have made changes as we discussed: a separate cheat sheet is created, pipelines are moved to the 4th position (between transformers and benchmarking), and transformers themselves are modified. Could you please let me know if I need to do something else here? I see this red button 'Changes requested', but I only managed to verify my changes and add a comment. |
Don't worry, we all have our lives and day jobs etc. The help here is much appreciated, and I'm certain that this will also be of substantial help for our users! |
Thanks a lot! Tests were failing due to the tutorial importing from |
Thank you! I still don't get the requested changes. Are they just pending and waiting for review? |
I still have to take some time review this, the requested changes are still open from last time, but please disregard for now. |
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 a lot, looks great!
I've added back a section that got lost along the way (the one with more tech details), at the end, apart from that, all perfect from my side!
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.
See above. Thanks!
Thanks a lot @fkiraly! I am really excited that my first PR to sktime got approved and merged! |
Reference Issues/PRs
Fixes #4373
What does this implement/fix? Explain your changes.
Adds the content from the tutorials at pydata global 2022 on pipelines,
transformers to the sktime main repo:
https://github.com/sktime/sktime-tutorial-pydata-global-2022
Content is notebooks 2 and 3 from pydata global.
Added in
03_transformers.ipynb
,03a_transformers_cheat_sheet
, and03b_forecasting_transformers_pipelines_tuning.ipynb
accordingly.Does your contribution introduce a new dependency? If yes, which one?
no
What should a reviewer concentrate their feedback on?
Did you add any tests for the change?
Any other comments?
PR checklist
For all contributions
For new estimators