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

Docs/general improvements #1904

Merged
merged 21 commits into from
Aug 4, 2023
Merged

Docs/general improvements #1904

merged 21 commits into from
Aug 4, 2023

Conversation

dennisbader
Copy link
Collaborator

Summary

General documentation improvements:

  • added model links to README.md and grouped them into model categories
  • added model links to covariates user guide
  • reorganized the forecasting model API section to better find models and see their model category
  • added the DTW (dynamic time warping) to the documentation and improvement it
  • some necessary updates to DTW module from changes over the years

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2023

Codecov Report

Patch coverage: 93.75% and project coverage change: -0.02 ⚠️

Comparison is base (933316b) 94.00% compared to head (cea95c2) 93.98%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1904      +/-   ##
==========================================
- Coverage   94.00%   93.98%   -0.02%     
==========================================
  Files         126      126              
  Lines       11905    11895      -10     
==========================================
- Hits        11191    11180      -11     
- Misses        714      715       +1     
Impacted Files Coverage Δ
darts/dataprocessing/dtw/__init__.py 100.00% <ø> (ø)
darts/models/forecasting/tide_model.py 97.22% <ø> (ø)
...arts/models/forecasting/torch_forecasting_model.py 90.46% <ø> (-0.04%) ⬇️
darts/dataprocessing/dtw/window.py 85.62% <87.50%> (-0.46%) ⬇️
darts/dataprocessing/dtw/dtw.py 94.28% <100.00%> (+0.08%) ⬆️

... and 5 files with indirect coverage changes

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

Copy link
Collaborator

@madtoinou madtoinou left a comment

Choose a reason for hiding this comment

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

I really like how you changed the tables summarizing all the available models, much clearer in my opinion!

Found a typo and a little inconsistency.

darts/dataprocessing/dtw/dtw.py Outdated Show resolved Hide resolved
docs/userguide/covariates.md Outdated Show resolved Hide resolved
dennisbader and others added 6 commits July 31, 2023 14:03
* added encode_train_inference to encoders

* added generate_fit_predict_encodings to ForecastingModel

* simplify TransferrableFut..Model.generatice_predict_encodings

* update changelog

* Apply suggestions from code review

Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>

* apply suggestions from PR review part 2

---------

Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>
@dennisbader dennisbader merged commit 8b88b0d into master Aug 4, 2023
9 checks passed
@dennisbader dennisbader deleted the docs/general_improvements branch August 4, 2023 13:33
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.

None yet

3 participants