Mirrors
/
hf_text-generation-inference
mirror of https://github.com/huggingface/text-generation-inference.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
hf_text-generation-inference/docs/source/_toctree.yml

50 lines
1.4 KiB
YAML
Raw Normal View History

Setup for doc-builder and docs for TGI (#740) I added ToC for docs v1 & started setting up for doc-builder. cc @Narsil @osanseviero --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: osanseviero <osanseviero@gmail.com> Co-authored-by: Mishig <mishig.davaadorj@coloradocollege.edu>
2023-08-10 02:24:52 -06:00
- sections:
- local: index
title: Text Generation Inference
- local: quicktour
title: Quick Tour
- local: installation
title: Installation
- local: supported_models
title: Supported Models and Hardware
Add messages api compatibility docs (#1478) This PR adds a new page to the docs that describes the Messages API and how to use it. Additionally this page will contain cloud provider specific information for enabling and using this feature. This PR includes a SageMaker example/information.
2024-01-24 09:41:28 -07:00
- local: messages_api
title: Messages API
Setup for doc-builder and docs for TGI (#740) I added ToC for docs v1 & started setting up for doc-builder. cc @Narsil @osanseviero --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: osanseviero <osanseviero@gmail.com> Co-authored-by: Mishig <mishig.davaadorj@coloradocollege.edu>
2023-08-10 02:24:52 -06:00
title: Getting started
- sections:
- local: basic_tutorials/consuming_tgi
title: Consuming TGI
- local: basic_tutorials/preparing_model
title: Preparing Model for Serving
- local: basic_tutorials/gated_model_access
title: Serving Private & Gated Models
Added CLI docs (#799) Added docs for CLI
2023-08-10 07:00:30 -06:00
- local: basic_tutorials/using_cli
title: Using TGI CLI
Automatic docs for TGI (#1045) I had to open this PR since I initially worked from my fork, and it requires a handful of work to trigger a new github action on my fork's specific branch (couldn't find a way, at least, despite trying all of them). --------- Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com>
2023-09-27 08:01:38 -06:00
- local: basic_tutorials/launcher
title: All TGI CLI options
Unsupported model serving docs (#906) Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Mishig <mishig.davaadorj@coloradocollege.edu> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: OlivierDehaene <olivier@huggingface.co>
2023-09-12 07:55:14 -06:00
- local: basic_tutorials/non_core_models
title: Non-core Model Serving
Pickle conversion now requires `--trust-remote-code`. (#1704) # What does this PR do? <!-- Congratulations! You've made it this far! You're not quite done yet though. Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your awesome contribution. Then, please replace this with a description of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies (if any) that are required for this change. Once you're done, someone will review your PR shortly (see the section "Who can review?" below to tag some potential reviewers). They may suggest changes to make the code even better. If no one reviewed your PR after a week has passed, don't hesitate to post a new comment @-mentioning the same persons---sometimes notifications get lost. --> <!-- Remove if not applicable --> Fixes # (issue) ## Before submitting - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [ ] Did you read the [contributor guideline](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md#start-contributing-pull-requests), Pull Request section? - [ ] Was this discussed/approved via a Github issue or the [forum](https://discuss.huggingface.co/)? Please add a link to it if that's the case. - [ ] Did you make sure to update the documentation with your changes? Here are the [documentation guidelines](https://github.com/huggingface/transformers/tree/main/docs), and [here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/main/docs#writing-source-documentation). - [ ] Did you write any new necessary tests? ## Who can review? Anyone in the community is free to review the PR once the tests have passed. Feel free to tag members/contributors who may be interested in your PR. <!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @ @OlivierDehaene OR @Narsil -->
2024-04-05 05:32:53 -06:00
- local: basic_tutorials/safety
title: Safety
feat: add vlm docs and simple examples (#1812) This PR start to add documentation for visual language models
2024-04-30 04:14:39 -06:00
- local: basic_tutorials/visual_language_models
title: Visual Language Models
Setup for doc-builder and docs for TGI (#740) I added ToC for docs v1 & started setting up for doc-builder. cc @Narsil @osanseviero --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: osanseviero <osanseviero@gmail.com> Co-authored-by: Mishig <mishig.davaadorj@coloradocollege.edu>
2023-08-10 02:24:52 -06:00
title: Tutorials
Add streaming guide (#858) Co-authored-by: Lucain <lucainp@gmail.com> Co-authored-by: Merve Noyan <merveenoyan@gmail.com>
2023-08-18 05:27:08 -06:00
- sections:
- local: conceptual/streaming
title: Streaming
Quantization docs (#911) Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
2023-09-12 07:52:46 -06:00
- local: conceptual/quantization
title: Quantization
Tensor Parallelism conceptual guide (#886) Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
2023-09-12 04:11:20 -06:00
- local: conceptual/tensor_parallelism
title: Tensor Parallelism
Paged Attention Conceptual Guide (#901)
2023-09-08 06:18:42 -06:00
- local: conceptual/paged_attention
title: PagedAttention
Safetensors conceptual guide (#905) IDK what else to add in this guide, I looked for relevant code in TGI codebase and saw that it's used in quantization as well (maybe I could add that?)
2023-09-07 08:22:06 -06:00
- local: conceptual/safetensors
title: Safetensors
docs: Flash Attention Conceptual Guide (#892) PR for conceptual guide on flash attention. I will add more info unless I'm told otherwise. --------- Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com>
2023-09-06 07:36:49 -06:00
- local: conceptual/flash_attention
title: Flash Attention
Fixing x-compute-time. (#1606) # What does this PR do? It was meant to be in seconds float <!-- Congratulations! You've made it this far! You're not quite done yet though. Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your awesome contribution. Then, please replace this with a description of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies (if any) that are required for this change. Once you're done, someone will review your PR shortly (see the section "Who can review?" below to tag some potential reviewers). They may suggest changes to make the code even better. If no one reviewed your PR after a week has passed, don't hesitate to post a new comment @-mentioning the same persons---sometimes notifications get lost. --> <!-- Remove if not applicable --> Fixes # (issue) ## Before submitting - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [ ] Did you read the [contributor guideline](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md#start-contributing-pull-requests), Pull Request section? - [ ] Was this discussed/approved via a Github issue or the [forum](https://discuss.huggingface.co/)? Please add a link to it if that's the case. - [ ] Did you make sure to update the documentation with your changes? Here are the [documentation guidelines](https://github.com/huggingface/transformers/tree/main/docs), and [here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/main/docs#writing-source-documentation). - [ ] Did you write any new necessary tests? ## Who can review? Anyone in the community is free to review the PR once the tests have passed. Feel free to tag members/contributors who may be interested in your PR. <!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @ @OlivierDehaene OR @Narsil -->
2024-02-28 03:30:37 -07:00
- local: conceptual/speculation
title: Speculation (Medusa, ngram)
- local: conceptual/guidance
title: Guidance, JSON, tools (using outlines)
feat: add vlm docs and simple examples (#1812) This PR start to add documentation for visual language models
2024-04-30 04:14:39 -06:00
Add streaming guide (#858) Co-authored-by: Lucain <lucainp@gmail.com> Co-authored-by: Merve Noyan <merveenoyan@gmail.com>
2023-08-18 05:27:08 -06:00
title: Conceptual Guides