New api docs structure #1379
Merged
New api docs structure #1379
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
Wauplin
reviewed
Aug 20, 2024
Vaibhavs10
reviewed
Aug 21, 2024
Co-authored-by: Pedro Cuenca <[email protected]>
Co-authored-by: Lucain <[email protected]>
* First draft for text-to-image * add correct code snippets * Update docs/api-inference/tasks/text-to-image.md Co-authored-by: Omar Sanseviero <[email protected]> * better table? * Generate tasks pages from script (#1386) * init project * first script to generate task pages * commit generated content * generate payload table as well * so undecisive * hey * better ? * Add image-to-image page * template for snippets section + few things * few things * Update scripts/api-inference/templates/specs_headers.handlebars Co-authored-by: Omar Sanseviero <[email protected]> * Update scripts/api-inference/templates/specs_headers.handlebars Co-authored-by: Omar Sanseviero <[email protected]> * generate * fetch inference status --------- Co-authored-by: Omar Sanseviero <[email protected]>
…b-docs into new_api_docs
|
It looks like you've updated documentation related to model or dataset cards in this PR. Some content is duplicated among the following files. Please make sure that everything stays consistent.
|
|
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. |
Co-authored-by: Pedro Cuenca <[email protected]>
Co-authored-by: Lucain <[email protected]>
* Filter out frozen models * use placeholder
* show as diff * reorder toctree * wording update * diff
* Add comment header on each task page * add huggingface.co/api/tasks
…classification (#1398) * Add token classification * add translation task * add zero shot classification * more parameters * More tasks more tasks more tasks! (#1399) * add ASR * fix early stopping parameter * regenrate * add audio_classification * Image classification * Object detection * image segementation * unknown when we don't know * gen * feature extraction * update
Wauplin
added a commit
to huggingface/huggingface.js
that referenced
this pull request
Aug 30, 2024
This PR should prove useful for the ongoing work of generating documentation pages based on the input/output specs (see huggingface/hub-docs#1379). In particular, I've made changes when adding new pages to the docs (PRs huggingface/hub-docs#1398 and huggingface/hub-docs#1399). This PR is now ready for review. **Changes:** - use enums instead of `oneOf` + list of `const` - do not rely on `"$ref": "/inference/schemas/text2text-generation/input.json",` for Summarization / Translation. Makes things clearer + it's not possible to extend the parameters which was not possible before. - typo in `text-to-image` - add `src_lang` and `tgt_lang` in translation params - use enum for `early_stopping` parameter (in common defs) - for `audio-classification`, `automatic speech recognition`, `image classification`, `image to image`, `object detection`: - mention `base64-encoded string` as input - mention raw data can be sent if no parameters in the JSON payload - more descriptions in `object detection` - more descriptions in `image segmentation` - mention bytes output in `text-to-image` and `image-to-image`
julien-c
reviewed
Sep 4, 2024
* Rename all tasks '_' to '-' * also for other urls
julien-c
reviewed
Sep 4, 2024
|
|
||
| | User Tier | Rate Limit | | ||
| |---------------------|---------------------------| | ||
| | Unregistered Users | 1 request per hour | |
There was a problem hiding this comment.
this is 0 no? for Unregistered Users
julien-c
reviewed
Sep 4, 2024
julien-c
reviewed
Sep 4, 2024
| client.text_classification("Today is a nice day") | ||
| ``` | ||
|
|
||
| ## JavaScript |
There was a problem hiding this comment.
you're not using the tabs component to switch programming languages?
gary149
reviewed
Sep 4, 2024
scripts/api-inference/templates/task/chat-completion.handlebars
Outdated
Show resolved
Hide resolved
gary149
reviewed
Sep 5, 2024
Co-authored-by: Victor Muštar <[email protected]>
* Update getting started examples * Move snippets above specification * custom link for finegrained token
Wauplin
reviewed
Sep 10, 2024
* Misc changes * Wrap up * Apply suggestions from code review * generate * Add todos to avoid forgetting about them --------- Co-authored-by: Lucain <[email protected]> Co-authored-by: Wauplin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(see discussion in private google docs)