-
Notifications
You must be signed in to change notification settings - Fork 259
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
Add CI workflow to auto-generate api inference documentation #1480
Conversation
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @hanouticelina, this makes perfect sense to have such a workflow!
Let's post in slack to get the GITHUB_TOKEN approval from the infra team (same as for the other 2 PRs)
Great idea! |
Seems to (finally) work fine now! :) Learnt a few things on the pnpm side 😄 |
@Wauplin should we add a cron job for this one? |
Yes, added it in the last commit ^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#1489 looks good now, having only the @huggingface/tasks
update makes sense IMO.
Time to merge I think once the workflow trigger is reverted to a cron job :)
thanks @Wauplin for the review! I reverted the workflow trigger to a cron job and I updated the PR body to specify that it also upgrades |
This PR adds an automated workflow to update the Inference API documentation whenever there are changes in the API tasks (https://huggingface.co/api/tasks).
As this endpoint and model inference status are regularly updated, maintaining an up-to-date Inference API documentation requires to run the
hub-docs/scripts/api-inference/generate
script and open a PR manually. Also, as the Inference API documentation is getting more attention recently, we might expect more requests to update the documentation (example in this internal slack message). This workflow will help avoid opening PRs manually each time the documentation needs to be updated.The initial idea was to add a cron job to run this workflow automatically on a regular basis. Would it make sense to add this automatic schedule?
Also, I'm using the same GH action as the one mentioned here (private) to create the PR. I want to have a first feedback on this before asking for repository permissions to allow the bot to create pull requests.
Note: All changes in the documentation are from running the
generate
scripts.