Skip to content
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

[ENH] Improving docs, examples, and tutorials of pytorch-forecasting #1745

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

julian-fong
Copy link
Contributor

relates to #1718

Implements the proposed changes in above issue.

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question, since this is not a draft - is this complete or still in progress? The changes currently are only a new table of contents, which is nice but not the entire scope of the issue.

@julian-fong
Copy link
Contributor Author

It's still in progress at the moment! Do drafts also trigger the read the docs build? I'm primarily keeping it in this state so that I can see how it looks like after changes

@fkiraly
Copy link
Collaborator

fkiraly commented Jan 4, 2025

yes, CI is triggered both by "ready" and "draft" PR. The "draft" state is mainly cosmetic and for signposting that it is not ready.

@julian-fong
Copy link
Contributor Author

julian-fong commented Jan 4, 2025

yes, CI is triggered both by "ready" and "draft" PR. The "draft" state is mainly cosmetic and for signposting that it is not ready.

Thanks! If you have anymore suggestions, feel free to post it here in or in the issue thread :). I'm not sure if we are planning to refactor the TimeSeriesDataSet class, but I feel like storing some pretrained dataset objects somewhere in the repo would make it easy to load and would make the tutorial much more simple.

@fkiraly
Copy link
Collaborator

fkiraly commented Jan 4, 2025

I'm not sure if we are planning to refactor the TimeSeriesDataSet class,

Yes, we probably will, see here: #1736
Comments appreciated, especially on usage!

What did you have in mind for the examples?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants