Skip to content

Conversation

Pinaka07
Copy link
Contributor

This PR makes the pytorch_forecasting model overview self-updating.

  • Adds a small Sphinx extension (docs/source/_ext/model_overview.py) that
    writes models.rst from registry.all_objects(), including optional model tags
    and links to API docs.
  • Wires the extension in conf.py and keeps a lightweight placeholder
    models.rst which is overwritten at build time.

Benefits

  • No manual updates when models are added/renamed.
  • Consistency with sktime’s estimator overview approach.
  • Safe, fail-soft behavior if imports break (docs still build with a note).

Copy link

codecov bot commented Aug 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@106f82f). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1958   +/-   ##
=======================================
  Coverage        ?   87.24%           
=======================================
  Files           ?      143           
  Lines           ?     8896           
  Branches        ?        0           
=======================================
  Hits            ?     7761           
  Misses          ?     1135           
  Partials        ?        0           
Flag Coverage Δ
cpu 87.24% <ø> (?)
pytest 87.24% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Pinaka07
Copy link
Contributor Author

@fkiraly can you please tell me why the docs build is failing.

@fkiraly
Copy link
Collaborator

fkiraly commented Aug 28, 2025

unsure, you can see the log here: https://app.readthedocs.org/api/v2/build/29355136.txt

It looks like import failures?

@Pinaka07
Copy link
Contributor Author

@fkiraly Thanks for helping, I think the PR is ready to be merged. Can you please review it ?

@fkiraly
Copy link
Collaborator

fkiraly commented Aug 31, 2025

hmm, seems like it does not work? This is how the file builds:

image

(it is on the doc build job - the "real" docs will look exactly the same if deployed)

@fkiraly
Copy link
Collaborator

fkiraly commented Sep 1, 2025

there are no import failures, I think the page is simply not being overwritten as you intend?

…s Name, Estimator Type, Authors, Maintainers, Dependencies columns
…s Name, Estimator Type, Authors, Maintainers, Dependencies columns
…nfig-inited; default to enabled (opt-out via PF_SKIP_MODEL_OVERVIEW)
@fkiraly
Copy link
Collaborator

fkiraly commented Sep 5, 2025

hm, I think it still does not work? Have a look at how sktime does this (in docs/conf.py)

@fkiraly
Copy link
Collaborator

fkiraly commented Sep 5, 2025

any ideas how to fix?

@Pinaka07
Copy link
Contributor Author

Pinaka07 commented Sep 7, 2025

any ideas how to fix?

Really sorry @fkiraly, as I was not able to respond. I am learning more about the sktime estimator overview and will update this code in a couple of days.

@fkiraly
Copy link
Collaborator

fkiraly commented Sep 7, 2025

no problem! Looking forward to this, the model overview will be great!

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