hub-docs
11595829 - New api docs structure (#1379)

Commit
1 year ago
New api docs structure (#1379) * Add draft of docs structure * Add index page * Prepare overview and rate limits * Manage redirects * Clean up * Apply suggestions from code review Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * Apply suggestions from review * Add additional headers * Apply suggestions from code review Co-authored-by: Lucain <lucain@huggingface.co> * Incorporate reviewer's feedback * First draft for text-to-image, image-to-image + generate script (#1384) * First draft for text-to-image * add correct code snippets * Update docs/api-inference/tasks/text-to-image.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * 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 <osanseviero@gmail.com> * Update scripts/api-inference/templates/specs_headers.handlebars Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * generate * fetch inference status --------- Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Add getting started * Add draft of docs structure * Add index page * Prepare overview and rate limits * Manage redirects * Clean up * Apply suggestions from review * Apply suggestions from code review Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * Add additional headers * Apply suggestions from code review Co-authored-by: Lucain <lucain@huggingface.co> * Incorporate reviewer's feedback * First draft for text-to-image, image-to-image + generate script (#1384) * First draft for text-to-image * add correct code snippets * Update docs/api-inference/tasks/text-to-image.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * 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 <osanseviero@gmail.com> * Update scripts/api-inference/templates/specs_headers.handlebars Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * generate * fetch inference status --------- Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Add getting started * Update docs/api-inference/getting_started.md Co-authored-by: Lucain <lucain@huggingface.co> * Draft to add text-generation parameters (#1393) * first draft to add text-generation parameters * headers * more structure * add chat-completion * better handling of arrays * better handling of parameters * Add new tasks pages (fill mask, summarization, question answering, sentence similarity) (#1394) * add fill mask * add summarization * add question answering * Table question answering * handle array output * Add sentence similarity * text classification (almost) * better with an enum * Add mask token * capitalize * remove sentence-similarity * Update docs/api-inference/tasks/table_question_answering.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> --------- Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * mention chat completion in text generation docs * fix chat completion snippets --------- Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Filter out frozen models from API docs for tasks (#1396) * Filter out frozen models * use placeholder * New api docs suggestions (#1397) * show as diff * reorder toctree * wording update * diff * Add comment header on each task page (#1400) * Add comment header on each task page * add huggingface.co/api/tasks * Add even more tasks: token classification, translation and zero shot 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 * regenerate * pull from main * coding style * Update _redirects.yml * Rename all tasks '_' to '-' (#1405) * Rename all tasks '_' to '-' * also for other urls * Update docs/api-inference/index.md Co-authored-by: Victor Muštar <victor.mustar@gmail.com> * Apply feedback for "new_api_docs" (#1408) * Update getting started examples * Move snippets above specification * custom link for finegrained token * Fixes new docs (#1413) * Misc changes * Wrap up * Apply suggestions from code review * generate * Add todos to avoid forgetting about them --------- Co-authored-by: Lucain <lucain@huggingface.co> Co-authored-by: Wauplin <lucainp@gmail.com> --------- Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Lucain <lucain@huggingface.co> Co-authored-by: Wauplin <lucainp@gmail.com> Co-authored-by: Victor Muštar <victor.mustar@gmail.com>
Author
Parents
Loading