-
Notifications
You must be signed in to change notification settings - Fork 705
[Docs] Auto-generate model overview from registry. #1958
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
base: main
Are you sure you want to change the base?
Conversation
…urce/_ext/model_overview.py; updates conf.py; simplifies models.rst)
… whitespace in model_overview extension
…sure compatibility with RTD runners
…fe mode fallback in model_overview extension
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1958 +/- ##
=======================================
Coverage ? 87.24%
=======================================
Files ? 143
Lines ? 8896
Branches ? 0
=======================================
Hits ? 7761
Misses ? 1135
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@fkiraly can you please tell me why the docs build is failing. |
unsure, you can see the log here: https://app.readthedocs.org/api/v2/build/29355136.txt It looks like import failures? |
@fkiraly Thanks for helping, I think the PR is ready to be merged. Can you please review it ? |
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)
hm, I think it still does not work? Have a look at how |
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. |
no problem! Looking forward to this, the model overview will be great! |
This PR makes the
pytorch_forecasting
model overview self-updating.docs/source/_ext/model_overview.py
) thatwrites
models.rst
fromregistry.all_objects()
, including optional model tagsand links to API docs.
conf.py
and keeps a lightweight placeholdermodels.rst
which is overwritten at build time.Benefits
sktime
’s estimator overview approach.