huggingface/text-generation-inference
5
0
Fork 0
mirror of https://github.com/huggingface/text-generation-inference.git synced 2025-09-10 20:04:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundant CLI md

Browse Source
This commit is contained in:
Merve Noyan 2023-08-10 13:48:15 +03:00 committed by GitHub
parent 15ef2bc082
commit 46a794e635
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
docs/source/basic_tutorials/using_cli.md
View File

@ -1,55 +0,0 @@
# Using TGI through CLI
You can use CLI tools of TGI to download weights, serve and quantize models, or get information on serving parameters.
## Installing TGI for CLI
To install TGI to use with CLI, you need to first clone the TGI repository, then inside the repository, run
```shell
make install
```
If you would like to serve models with custom kernels, run
```shell
BUILD_EXTENSIONS=True make install
```
## Running CLI
After installation, you will be able to use `text-generation-server` and `text-generation-launcher`.
`text-generation-server` lets you download the model with `download-weights` command like below 👇
```shell
text-generation-server download-weights MODEL_HUB_ID
```
You can also use it to quantize models like below 👇
```shell
text-generation-server quantize MODEL_HUB_ID OUTPUT_DIR
```
You can use `text-generation-launcher` to serve models.
```shell
text-generation-launcher --model-id MODEL_HUB_ID --port 8080
```
There are many options and parameters you can pass to `text-generation-launcher`. The documentation for CLI is kept minimal and intended to rely on self-generating documentation, which can be found by running
```shell
text-generation-launcher --help
```
You can also find it hosted in this [Swagger UI](https://huggingface.github.io/text-generation-inference/).
Same documentation can be found for `text-generation-server`.
```shell
text-generation-server --help
```