[Docs] Auto-generate model overview from registry.

[Pinaka07]

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).

closes #1934

[codecov]

Codecov Report

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1958   +/-   ##
=======================================
  Coverage        ?   86.97%           
=======================================
  Files           ?      160           
  Lines           ?     9463           
  Branches        ?        0           
=======================================
  Hits            ?     8230           
  Misses          ?     1233           
  Partials        ?        0           

Flag	Coverage Δ
cpu	86.97% <ø> (?)
pytest	86.97% <ø> (?)

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]

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

[fkiraly]

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

It looks like import failures?

[Pinaka07]

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

[fkiraly]

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

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

[fkiraly]

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

[fkiraly]

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

[fkiraly]

any ideas how to fix?

[Pinaka07]

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]

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

[Pinaka07]

Hi @fkiraly @christy @rustyconover @szepeviktor
I have resolved all the merge conflicts and ran unit tests for the logic verification

This PR is now ready for review.
Please review it and suggest modification.

Thank you.

[fkiraly]

Nice!

• It seems code formatting and readthedocs (documentation build) are failing - could you kindly look into that?
• it seems you accidentally committed your venv to the branch, please remove this
• same for the documentation build, this should not be committed to the repo

[Pinaka07]

Hey @fkiraly @christy @rustyconover @szepeviktor
After months long effort debugging and testing, I have finally fixed the issue, the table is now auto-generated and is accurate as per issue description, I request you to review my implementation, and suggest changes(if any). The PR is ready to be merged!

[phoeenniixx]

Great Work! Thanks!
I want to suggest few points:

• By looking at the screenshot you shared, the model overview is showing both metrics and the models, is it possible to display only models there and for metrics we have a different table? Ideally, the metrics should be shown in the metrics overview,
• When I am trying to see the rendering using the CI, I cant see the table and this is what I get instead... Can you please have a look at it

I am assuming there maybe some issue with the font color etc as well but I am not sure