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

[DOC] Improve the TFM user guide #1661

Merged
merged 9 commits into from
Apr 7, 2023
Merged

[DOC] Improve the TFM user guide #1661

merged 9 commits into from
Apr 7, 2023

Conversation

madtoinou
Copy link
Collaborator

Fixes #1576 and fixes #1245.

Summary

  • Update the Torch Forecasting Models user guide to better cover the save/load functionalities, notably for training on GPU and inference on CPU.
  • Also include some examples of Callbacks : Early stopping and LossLogger, as well as a link to the callbacks implement by PyTorchLightning.
  • Add a hint in the FAQ, to help troubleshooting NaNs in the predictions.

Other Information

The next release is going to break the compatibility with checkpoints obtained with older version of Darts, we should probably start documenting ways to convert them so that user can systematically migrate to the latest versions

@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.09 ⚠️

Comparison is base (69e83dc) 94.14% compared to head (37323cc) 94.05%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1661      +/-   ##
==========================================
- Coverage   94.14%   94.05%   -0.09%     
==========================================
  Files         125      125              
  Lines       11385    11371      -14     
==========================================
- Hits        10718    10695      -23     
- Misses        667      676       +9     

see 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@dennisbader dennisbader left a comment

Choose a reason for hiding this comment

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

Looks great, thanks a lot!

docs/userguide/torch_forecasting_models.md Outdated Show resolved Hide resolved
@dennisbader dennisbader merged commit fcd12c2 into master Apr 7, 2023
@dennisbader dennisbader deleted the doc/TFM-guide branch April 7, 2023 13:33
alexcolpitts96 pushed a commit to alexcolpitts96/darts that referenced this pull request May 31, 2023
* doc: reorganizing the TFM guide and extending the section about save/load as well as the callbacks

* doc: adding command line instruction for tensorboard

* doc: more detailed information about the NaNs in predictions

* doc: creating a separate section for loading of weights, improved the table of content, added red crosses in covariate support tables

* update tfm user guide

* update tfm user guide

* remove cloud storage section as it does not work

---------

Co-authored-by: dennisbader <dennis.bader@gmx.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants