2023-05-12 12:46:41 +00:00
use clap ::{ Parser , ValueEnum } ;
2024-04-12 12:20:31 +00:00
use hf_hub ::{ api ::sync ::Api , Repo , RepoType } ;
2023-07-13 12:22:37 +00:00
use nix ::sys ::signal ::{ self , Signal } ;
use nix ::unistd ::Pid ;
2023-04-16 22:26:47 +00:00
use serde ::Deserialize ;
2022-10-22 18:00:15 +00:00
use std ::env ;
2023-02-16 10:20:23 +00:00
use std ::ffi ::OsString ;
2024-01-25 17:16:03 +00:00
use std ::io ::{ BufRead , BufReader , Lines } ;
2023-07-13 12:22:37 +00:00
use std ::os ::unix ::process ::{ CommandExt , ExitStatusExt } ;
2022-10-18 13:19:03 +00:00
use std ::path ::Path ;
2023-07-14 14:31:48 +00:00
use std ::process ::{ Child , Command , ExitStatus , Stdio } ;
2022-10-18 13:19:03 +00:00
use std ::sync ::atomic ::{ AtomicBool , Ordering } ;
use std ::sync ::mpsc ::TryRecvError ;
2023-06-30 21:09:20 +00:00
use std ::sync ::{ mpsc , Arc } ;
2022-10-18 13:19:03 +00:00
use std ::thread ;
use std ::thread ::sleep ;
use std ::time ::{ Duration , Instant } ;
use std ::{ fs , io } ;
2024-05-06 11:48:11 +00:00
use thiserror ::Error ;
2024-05-23 13:40:40 +00:00
use tracing_subscriber ::{ filter ::LevelFilter , EnvFilter } ;
2022-10-18 13:19:03 +00:00
2023-05-02 13:43:19 +00:00
mod env_runtime ;
2024-04-12 12:20:31 +00:00
#[ derive(Deserialize) ]
2024-05-23 12:39:38 +00:00
struct RawConfig {
2024-04-12 12:20:31 +00:00
max_position_embeddings : Option < usize > ,
2024-05-23 12:39:38 +00:00
n_positions : Option < usize > ,
2024-04-12 12:20:31 +00:00
max_seq_len : Option < usize > ,
}
2024-05-23 12:39:38 +00:00
#[ derive(Deserialize) ]
struct Config {
max_position_embeddings : Option < usize > ,
}
impl From < RawConfig > for Config {
fn from ( other : RawConfig ) -> Self {
let max_position_embeddings = other
. max_position_embeddings
. or ( other . max_seq_len )
. or ( other . n_positions ) ;
Config {
max_position_embeddings ,
}
}
}
2023-05-12 12:46:41 +00:00
#[ derive(Clone, Copy, Debug, ValueEnum) ]
enum Quantization {
2024-01-26 09:41:58 +00:00
/// 4 bit quantization. Requires a specific AWQ quantized model:
2024-04-12 12:20:31 +00:00
/// <https://hf.co/models?search=awq>.
2024-01-26 09:41:58 +00:00
/// Should replace GPTQ models wherever possible because of the better latency
2023-09-27 09:42:57 +00:00
Awq ,
/// 8 bit quantization, doesn't require specific model.
/// Should be a drop-in replacement to bitsandbytes with much better performance.
2024-04-12 12:20:31 +00:00
/// Kernels are from <https://github.com/NetEase-FuXi/EETQ.git>
2023-09-27 09:42:57 +00:00
Eetq ,
2024-05-28 09:51:31 +00:00
/// Variable bit quantization. Requires a specific EXL2 quantized model:
/// <https://hf.co/models?search=exl2>. Requires exllama2 kernels and does
/// not support tensor parallelism (num_shard > 1).
Exl2 ,
2024-04-12 12:20:31 +00:00
/// 4 bit quantization. Requires a specific GTPQ quantized model: <https://hf.co/models?search=gptq>.
2024-01-26 09:41:58 +00:00
/// text-generation-inference will use exllama (faster) kernels wherever possible, and use
2023-09-27 09:42:57 +00:00
/// triton kernel (wider support) when it's not.
/// AWQ has faster kernels.
Gptq ,
2024-06-05 08:14:40 +00:00
/// 4 bit quantization. Requires a specific Marlin quantized model: <https://hf.co/models?search=marlin>.
Marlin ,
2023-09-27 09:42:57 +00:00
/// Bitsandbytes 8bit. Can be applied on any model, will cut the memory requirement in half,
/// but it is known that the model will be much slower to run than the native f16.
#[ deprecated(
since = " 1.1.0 " ,
note = " Use `eetq` instead, which provides better latencies overall and is drop-in in most cases "
) ]
2023-05-12 12:46:41 +00:00
Bitsandbytes ,
2023-09-27 09:42:57 +00:00
/// Bitsandbytes 4bit. Can be applied on any model, will cut the memory requirement by 4x,
/// but it is known that the model will be much slower to run than the native f16.
2023-08-03 21:00:59 +00:00
BitsandbytesNF4 ,
2023-09-27 09:42:57 +00:00
/// Bitsandbytes 4bit. nf4 should be preferred in most cases but maybe this one has better
/// perplexity performance for you model
2023-08-03 21:00:59 +00:00
BitsandbytesFP4 ,
2024-04-12 06:13:30 +00:00
/// [FP8](https://developer.nvidia.com/blog/nvidia-arm-and-intel-publish-fp8-specification-for-standardization-as-an-interchange-format-for-ai/) (e4m3) works on H100 and above
/// This dtype has native ops should be the fastest if available.
/// This is currently not the fastest because of local unpacking + padding to satisfy matrix
/// multiplication limitations.
Fp8 ,
2023-05-12 12:46:41 +00:00
}
impl std ::fmt ::Display for Quantization {
fn fmt ( & self , f : & mut std ::fmt ::Formatter < '_ > ) -> std ::fmt ::Result {
// To keep in track with `server`.
match self {
2024-01-22 14:22:54 +00:00
#[ allow(deprecated) ]
// Use `eetq` instead, which provides better latencies overall and is drop-in in most cases
2023-05-12 12:46:41 +00:00
Quantization ::Bitsandbytes = > {
write! ( f , " bitsandbytes " )
}
2023-08-03 21:00:59 +00:00
Quantization ::BitsandbytesNF4 = > {
write! ( f , " bitsandbytes-nf4 " )
}
Quantization ::BitsandbytesFP4 = > {
write! ( f , " bitsandbytes-fp4 " )
}
2024-05-28 09:51:31 +00:00
Quantization ::Exl2 = > {
write! ( f , " exl2 " )
}
2023-05-12 12:46:41 +00:00
Quantization ::Gptq = > {
write! ( f , " gptq " )
}
2024-06-05 08:14:40 +00:00
Quantization ::Marlin = > {
write! ( f , " marlin " )
}
Add AWQ quantization inference support (#1019) (#1054)
# Add AWQ quantization inference support
Fixes
https://github.com/huggingface/text-generation-inference/issues/781
This PR (partially) adds support for AWQ quantization for inference.
More information on AWQ [here](https://arxiv.org/abs/2306.00978). In
general, AWQ is faster and more accurate than GPTQ, which is currently
supported by TGI.
This PR installs 4-bit GEMM custom CUDA kernels released by AWQ authors
(in `requirements.txt`, just one line change).
Quick way to test this PR would be bring up TGI as follows:
```
text-generation-server download-weights abhinavkulkarni/codellama-CodeLlama-7b-Python-hf-w4-g128-awq
text-generation-launcher \
--huggingface-hub-cache ~/.cache/huggingface/hub/ \
--model-id abhinavkulkarni/codellama-CodeLlama-7b-Python-hf-w4-g128-awq \
--trust-remote-code --port 8080 \
--max-input-length 2048 --max-total-tokens 4096 --max-batch-prefill-tokens 4096 \
--quantize awq
```
Please note:
* This PR was tested with FlashAttention v2 and vLLM.
* This PR adds support for AWQ inference, not quantizing the models.
That needs to be done outside of TGI, instructions
[here](https://github.com/mit-han-lab/llm-awq/tree/f084f40bd996f3cf3a0633c1ad7d9d476c318aaa).
* This PR only adds support for `FlashLlama` models for now.
* Multi-GPU setup has not been tested.
* No integration tests have been added so far, will add later if
maintainers are interested in this change.
* This PR can be tested on any of the models released
[here](https://huggingface.co/abhinavkulkarni?sort_models=downloads#models).
Please refer to the linked issue for benchmarks for
[abhinavkulkarni/meta-llama-Llama-2-7b-chat-hf-w4-g128-awq](https://huggingface.co/abhinavkulkarni/meta-llama-Llama-2-7b-chat-hf-w4-g128-awq)
vs
[TheBloke/Llama-2-7b-Chat-GPTQ](https://huggingface.co/TheBloke/Llama-2-7b-Chat-GPTQ).
Please note, AWQ has released faster (and in case of Llama, fused)
kernels for 4-bit GEMM, currently at the top of the `main` branch at
https://github.com/mit-han-lab/llm-awq, but this PR uses an older commit
that has been tested to work. We can switch to latest commit later on.
## Who can review?
@OlivierDehaene OR @Narsil
---------
# 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
-->
---------
Co-authored-by: Abhinav M Kulkarni <abhinavkulkarni@gmail.com>
Co-authored-by: Abhinav Kulkarni <abhinav@concentric.ai>
2023-09-25 13:31:27 +00:00
Quantization ::Awq = > {
write! ( f , " awq " )
}
2023-09-27 09:42:57 +00:00
Quantization ::Eetq = > {
write! ( f , " eetq " )
}
2024-04-12 06:13:30 +00:00
Quantization ::Fp8 = > {
write! ( f , " fp8 " )
}
2023-05-12 12:46:41 +00:00
}
}
}
2023-06-30 18:30:09 +00:00
#[ derive(Clone, Copy, Debug, ValueEnum) ]
enum Dtype {
Float16 ,
2023-07-17 16:38:16 +00:00
#[ clap(name = " bfloat16 " ) ]
2023-06-30 18:30:09 +00:00
BFloat16 ,
}
impl std ::fmt ::Display for Dtype {
fn fmt ( & self , f : & mut std ::fmt ::Formatter < '_ > ) -> std ::fmt ::Result {
// To keep in track with `server`.
match self {
Dtype ::Float16 = > {
write! ( f , " float16 " )
}
Dtype ::BFloat16 = > {
write! ( f , " bfloat16 " )
}
}
}
}
2023-07-31 13:38:47 +00:00
#[ derive(Clone, Copy, Debug, ValueEnum) ]
enum RopeScaling {
Linear ,
Dynamic ,
}
impl std ::fmt ::Display for RopeScaling {
fn fmt ( & self , f : & mut std ::fmt ::Formatter < '_ > ) -> std ::fmt ::Result {
// To keep in track with `server`.
match self {
RopeScaling ::Linear = > {
write! ( f , " linear " )
}
RopeScaling ::Dynamic = > {
write! ( f , " dynamic " )
}
}
}
}
2022-10-18 13:19:03 +00:00
/// App Configuration
#[ derive(Parser, Debug) ]
#[ clap(author, version, about, long_about = None) ]
struct Args {
2023-04-29 09:53:42 +00:00
/// The name of the model to load.
/// Can be a MODEL_ID as listed on <https://hf.co/models> like
/// `gpt2` or `OpenAssistant/oasst-sft-1-pythia-12b`.
/// Or it can be a local directory containing the necessary files
/// as saved by `save_pretrained(...)` methods of transformers
2022-10-18 13:19:03 +00:00
#[ clap(default_value = " bigscience/bloom-560m " , long, env) ]
2023-02-03 11:43:37 +00:00
model_id : String ,
2023-04-29 09:53:42 +00:00
/// The actual revision of the model if you're referring to a model
/// on the hub. You can use a specific commit id or a branch like `refs/pr/2`.
2022-10-18 13:19:03 +00:00
#[ clap(long, env) ]
2023-01-31 17:53:56 +00:00
revision : Option < String > ,
2023-04-29 09:53:42 +00:00
2023-07-13 12:22:37 +00:00
/// The number of tokenizer workers used for payload validation and truncation inside the
/// router.
#[ clap(default_value = " 2 " , long, env) ]
validation_workers : usize ,
2023-05-23 18:40:39 +00:00
/// Whether to shard the model across multiple GPUs
2023-04-29 09:53:42 +00:00
/// By default text-generation-inference will use all available GPUs to run
/// the model. Setting it to `false` deactivates `num_shard`.
2023-03-08 10:06:59 +00:00
#[ clap(long, env) ]
sharded : Option < bool > ,
2023-04-29 09:53:42 +00:00
/// The number of shards to use if you don't want to use all GPUs on a given machine.
2023-06-12 11:59:22 +00:00
/// You can use `CUDA_VISIBLE_DEVICES=0,1 text-generation-launcher... --num_shard 2`
/// and `CUDA_VISIBLE_DEVICES=2,3 text-generation-launcher... --num_shard 2` to
2023-04-29 09:53:42 +00:00
/// launch 2 copies with 2 shard each on a given machine with 4 GPUs for instance.
2023-03-08 10:06:59 +00:00
#[ clap(long, env) ]
num_shard : Option < usize > ,
2023-04-29 09:53:42 +00:00
2023-09-27 09:42:57 +00:00
/// Whether you want the model to be quantized.
2023-05-12 12:46:41 +00:00
#[ clap(long, env, value_enum) ]
quantize : Option < Quantization > ,
2023-04-29 09:53:42 +00:00
2023-12-11 11:46:30 +00:00
/// The number of input_ids to speculate on
/// If using a medusa model, the heads will be picked up automatically
/// Other wise, it will use n-gram speculation which is relatively free
/// in terms of compute, but the speedup heavily depends on the task.
#[ clap(long, env) ]
speculate : Option < usize > ,
2023-06-30 18:30:09 +00:00
/// The dtype to be forced upon the model. This option cannot be used with `--quantize`.
#[ clap(long, env, value_enum) ]
dtype : Option < Dtype > ,
2023-05-23 18:40:39 +00:00
/// Whether you want to execute hub modelling code. Explicitly passing a `revision` is
/// encouraged when loading a model with custom code to ensure no malicious code has been
/// contributed in a newer revision.
#[ clap(long, env, value_enum) ]
trust_remote_code : bool ,
2023-04-29 09:53:42 +00:00
/// The maximum amount of concurrent requests for this particular deployment.
/// Having a low limit will refuse clients requests instead of having them
/// wait for too long and is usually good to handle backpressure correctly.
2022-10-18 13:19:03 +00:00
#[ clap(default_value = " 128 " , long, env) ]
max_concurrent_requests : usize ,
2023-04-29 09:53:42 +00:00
/// This is the maximum allowed value for clients to set `best_of`.
/// Best of makes `n` generations at the same time, and return the best
/// in terms of overall log probability over the entire generated sequence
2023-03-09 14:30:54 +00:00
#[ clap(default_value = " 2 " , long, env) ]
max_best_of : usize ,
2023-04-29 09:53:42 +00:00
/// This is the maximum allowed value for clients to set `stop_sequences`.
/// Stop sequences are used to allow the model to stop on more than just
/// the EOS token, and enable more complex "prompting" where users can preprompt
/// the model in a specific way and define their "own" stop token aligned with
/// their prompt.
2023-03-03 15:01:25 +00:00
#[ clap(default_value = " 4 " , long, env) ]
max_stop_sequences : usize ,
2023-04-29 09:53:42 +00:00
2023-08-28 09:43:47 +00:00
/// This is the maximum allowed value for clients to set `top_n_tokens`.
2024-05-31 16:42:14 +00:00
/// `top_n_tokens` is used to return information about the the `n` most likely
2023-08-28 09:43:47 +00:00
/// tokens at each generation step, instead of just the sampled token. This
/// information can be used for downstream tasks like for classification or
/// ranking.
#[ clap(default_value = " 5 " , long, env) ]
max_top_n_tokens : u32 ,
2023-04-29 09:53:42 +00:00
/// This is the maximum allowed input length (expressed in number of tokens)
/// for users. The larger this value, the longer prompt users can send which
/// can impact the overall memory required to handle the load.
/// Please note that some models have a finite range of sequence they can handle.
2024-04-12 12:20:31 +00:00
/// Default to min(max_position_embeddings - 1, 4095)
#[ clap(long, env) ]
max_input_tokens : Option < usize > ,
/// Legacy version of [`Args::max_input_tokens`].
#[ clap(long, env) ]
max_input_length : Option < usize > ,
2023-04-29 09:53:42 +00:00
/// This is the most important value to set as it defines the "memory budget"
/// of running clients requests.
/// Clients will send input sequences and ask to generate `max_new_tokens`
/// on top. with a value of `1512` users can send either a prompt of
/// `1000` and ask for `512` new tokens, or send a prompt of `1` and ask for
/// `1511` max_new_tokens.
/// The larger this value, the larger amount each request will be in your RAM
/// and the less effective batching can be.
2024-04-12 12:20:31 +00:00
/// Default to min(max_position_embeddings, 4096)
#[ clap(long, env) ]
max_total_tokens : Option < usize > ,
2023-04-29 09:53:42 +00:00
/// This represents the ratio of waiting queries vs running queries where
/// you want to start considering pausing the running queries to include the waiting
/// ones into the same batch.
/// `waiting_served_ratio=1.2` Means when 12 queries are waiting and there's
/// only 10 queries left in the current batch we check if we can fit those 12
/// waiting queries into the batching strategy, and if yes, then batching happens
/// delaying the 10 running queries by a `prefill` run.
///
/// This setting is only applied if there is room in the batch
/// as defined by `max_batch_total_tokens`.
2024-04-28 15:54:19 +00:00
#[ clap(default_value = " 0.3 " , long, env) ]
2023-04-24 15:59:00 +00:00
waiting_served_ratio : f32 ,
2023-04-29 09:53:42 +00:00
2023-06-30 17:09:59 +00:00
/// Limits the number of tokens for the prefill operation.
/// Since this operation take the most memory and is compute bound, it is interesting
/// to limit the number of requests that can be sent.
2024-04-12 12:20:31 +00:00
/// Default to `max_input_tokens + 50` to give a bit of room.
#[ clap(long, env) ]
max_batch_prefill_tokens : Option < u32 > ,
2023-06-30 17:09:59 +00:00
2023-04-29 09:53:42 +00:00
/// **IMPORTANT** This is one critical control to allow maximum usage
/// of the available hardware.
///
/// This represents the total amount of potential tokens within a batch.
/// When using padding (not recommended) this would be equivalent of
/// `batch_size` * `max_total_tokens`.
///
/// However in the non-padded (flash attention) version this can be much finer.
///
/// For `max_batch_total_tokens=1000`, you could fit `10` queries of `total_tokens=100`
/// or a single query of `1000` tokens.
///
/// Overall this number should be the largest possible amount that fits the
/// remaining memory (after the model is loaded). Since the actual memory overhead
/// depends on other parameters like if you're using quantization, flash attention
/// or the model implementation, text-generation-inference cannot infer this number
/// automatically.
2023-07-19 07:31:25 +00:00
#[ clap(long, env) ]
max_batch_total_tokens : Option < u32 > ,
2023-04-29 09:53:42 +00:00
/// This setting defines how many tokens can be passed before forcing the waiting
/// queries to be put on the batch (if the size of the batch allows for it).
/// New queries require 1 `prefill` forward, which is different from `decode`
/// and therefore you need to pause the running batch in order to run `prefill`
/// to create the correct values for the waiting queries to be able to join the batch.
///
/// With a value too small, queries will always "steal" the compute to run `prefill`
/// and running queries will be delayed by a lot.
///
/// With a value too big, waiting queries could wait for a very long time
/// before being allowed a slot in the running batch. If your server is busy
/// that means that requests that could run in ~2s on an empty server could
/// end up running in ~20s because the query had to wait for 18s.
///
/// This number is expressed in number of tokens to make it a bit more
/// "model" agnostic, but what should really matter is the overall latency
/// for end users.
2022-10-21 14:40:05 +00:00
#[ clap(default_value = " 20 " , long, env) ]
max_waiting_tokens : usize ,
2023-04-29 09:53:42 +00:00
2024-02-09 11:38:41 +00:00
/// Enforce a maximum number of requests per batch
/// Specific flag for hardware targets that do not support unpadded inference
#[ clap(long, env) ]
max_batch_size : Option < usize > ,
2024-04-04 21:01:56 +00:00
/// Specify the batch sizes to compute cuda graphs for.
/// Use "0" to disable.
2024-04-12 12:20:31 +00:00
/// Default = "1,2,4,8,16,32"
#[ clap(long, env, value_delimiter = ',') ]
cuda_graphs : Option < Vec < usize > > ,
2024-02-12 09:09:29 +00:00
2023-07-05 16:28:45 +00:00
/// The IP address to listen on
#[ clap(default_value = " 0.0.0.0 " , long, env) ]
hostname : String ,
2023-04-29 09:53:42 +00:00
/// The port to listen on.
2023-06-30 17:09:59 +00:00
#[ clap(default_value = " 3000 " , long, short, env) ]
2022-10-18 13:19:03 +00:00
port : u16 ,
2023-04-29 09:53:42 +00:00
/// The name of the socket for gRPC communication between the webserver
/// and the shards.
2022-10-18 13:19:03 +00:00
#[ clap(default_value = " /tmp/text-generation-server " , long, env) ]
shard_uds_path : String ,
2023-04-29 09:53:42 +00:00
/// The address the master shard will listen on. (setting used by torch distributed)
2023-02-08 16:53:33 +00:00
#[ clap(default_value = " localhost " , long, env) ]
2022-10-18 13:19:03 +00:00
master_addr : String ,
2023-04-29 09:53:42 +00:00
/// The address the master port will listen on. (setting used by torch distributed)
2023-02-08 16:53:33 +00:00
#[ clap(default_value = " 29500 " , long, env) ]
2022-10-18 13:19:03 +00:00
master_port : usize ,
2023-04-29 09:53:42 +00:00
/// The location of the huggingface hub cache.
/// Used to override the location if you want to provide a mounted disk for instance
2022-11-02 16:29:56 +00:00
#[ clap(long, env) ]
2023-02-14 12:02:16 +00:00
huggingface_hub_cache : Option < String > ,
2023-04-29 09:53:42 +00:00
/// The location of the huggingface hub cache.
/// Used to override the location if you want to provide a mounted disk for instance
2023-02-14 12:02:16 +00:00
#[ clap(long, env) ]
weights_cache_override : Option < String > ,
2023-04-29 09:53:42 +00:00
/// For some models (like bloom), text-generation-inference implemented custom
/// cuda kernels to speed up inference. Those kernels were only tested on A100.
/// Use this flag to disable them if you're running on different hardware and
/// encounter issues.
2023-02-14 12:02:16 +00:00
#[ clap(long, env) ]
2023-02-15 15:23:45 +00:00
disable_custom_kernels : bool ,
2023-04-29 09:53:42 +00:00
2023-07-24 09:43:58 +00:00
/// Limit the CUDA available memory.
/// The allowed value equals the total visible memory multiplied by cuda-memory-fraction.
#[ clap(default_value = " 1.0 " , long, env) ]
cuda_memory_fraction : f32 ,
2023-07-31 13:38:47 +00:00
/// Rope scaling will only be used for RoPE models
/// and allow rescaling the position rotary to accomodate for
/// larger prompts.
///
/// Goes together with `rope_factor`.
///
/// `--rope-factor 2.0` gives linear scaling with a factor of 2.0
/// `--rope-scaling dynamic` gives dynamic scaling with a factor of 1.0
/// `--rope-scaling linear` gives linear scaling with a factor of 1.0 (Nothing will be changed
/// basically)
///
/// `--rope-scaling linear --rope-factor` fully describes the scaling you want
#[ clap(long, env) ]
rope_scaling : Option < RopeScaling > ,
/// Rope scaling will only be used for RoPE models
/// See `rope_scaling`
#[ clap(long, env) ]
rope_factor : Option < f32 > ,
2023-04-29 09:53:42 +00:00
/// Outputs the logs in JSON format (useful for telemetry)
2023-02-15 15:23:45 +00:00
#[ clap(long, env) ]
2022-11-02 16:29:56 +00:00
json_output : bool ,
2023-04-29 09:53:42 +00:00
2023-02-13 12:02:45 +00:00
#[ clap(long, env) ]
otlp_endpoint : Option < String > ,
2023-04-29 09:53:42 +00:00
2023-02-17 17:22:00 +00:00
#[ clap(long, env) ]
cors_allow_origin : Vec < String > ,
2023-03-02 11:30:41 +00:00
#[ clap(long, env) ]
watermark_gamma : Option < f32 > ,
#[ clap(long, env) ]
watermark_delta : Option < f32 > ,
2023-05-02 13:43:19 +00:00
2023-06-16 14:25:11 +00:00
/// Enable ngrok tunneling
#[ clap(long, env) ]
ngrok : bool ,
/// ngrok authentication token
#[ clap(long, env) ]
ngrok_authtoken : Option < String > ,
2023-07-19 09:59:58 +00:00
/// ngrok edge
2023-06-16 14:25:11 +00:00
#[ clap(long, env) ]
2023-07-19 09:59:58 +00:00
ngrok_edge : Option < String > ,
2023-06-16 14:25:11 +00:00
2024-01-26 17:01:33 +00:00
/// The path to the tokenizer config file. This path is used to load the tokenizer configuration which may
/// include a `chat_template`. If not provided, the default config will be used from the model hub.
#[ clap(long, env) ]
tokenizer_config_path : Option < String > ,
2024-02-15 09:28:10 +00:00
/// Disable outlines grammar constrained generation.
/// This is a feature that allows you to generate text that follows a specific grammar.
#[ clap(long, env) ]
disable_grammar_support : bool ,
2023-05-02 13:43:19 +00:00
/// Display a lot of information about your runtime environment
#[ clap(long, short, action) ]
env : bool ,
2024-04-17 08:41:12 +00:00
/// Control the maximum number of inputs that a client can send in a single request
#[ clap(default_value = " 4 " , long, env) ]
max_client_batch_size : usize ,
2024-06-06 23:49:07 +00:00
/// Lora Adapters a list of adapter ids i.e. `repo/adapter1,repo/adapter2` to load during
/// startup that will be available to callers via the `adapter_id` field in a request.
#[ clap(long, env) ]
lora_adapters : Option < String > ,
2022-10-18 13:19:03 +00:00
}
2023-04-26 12:43:36 +00:00
#[ derive(Debug) ]
enum ShardStatus {
Ready ,
2023-07-17 17:03:07 +00:00
Failed ( usize ) ,
2023-04-26 12:43:36 +00:00
}
2023-02-15 15:11:32 +00:00
2023-04-26 12:43:36 +00:00
#[ allow(clippy::too_many_arguments) ]
fn shard_manager (
model_id : String ,
revision : Option < String > ,
2023-05-12 12:46:41 +00:00
quantize : Option < Quantization > ,
2023-12-11 11:46:30 +00:00
speculate : Option < usize > ,
2023-06-30 18:30:09 +00:00
dtype : Option < Dtype > ,
2023-05-23 18:40:39 +00:00
trust_remote_code : bool ,
2023-04-26 12:43:36 +00:00
uds_path : String ,
rank : usize ,
world_size : usize ,
master_addr : String ,
master_port : usize ,
huggingface_hub_cache : Option < String > ,
weights_cache_override : Option < String > ,
disable_custom_kernels : bool ,
watermark_gamma : Option < f32 > ,
watermark_delta : Option < f32 > ,
2024-04-04 21:01:56 +00:00
cuda_graphs : Vec < usize > ,
2023-07-24 09:43:58 +00:00
cuda_memory_fraction : f32 ,
2023-07-31 13:38:47 +00:00
rope_scaling : Option < RopeScaling > ,
rope_factor : Option < f32 > ,
2024-04-26 13:44:44 +00:00
max_total_tokens : usize ,
max_batch_size : Option < usize > ,
2024-06-10 07:09:50 +00:00
max_input_tokens : usize ,
2024-06-06 23:49:07 +00:00
lora_adapters : Option < String > ,
2023-04-26 12:43:36 +00:00
otlp_endpoint : Option < String > ,
2024-05-23 13:40:40 +00:00
log_level : LevelFilter ,
2023-04-26 12:43:36 +00:00
status_sender : mpsc ::Sender < ShardStatus > ,
2023-06-30 21:09:20 +00:00
shutdown : Arc < AtomicBool > ,
2023-04-26 12:43:36 +00:00
_shutdown_sender : mpsc ::Sender < ( ) > ,
) {
2023-07-17 17:03:07 +00:00
// Enter shard-manager tracing span
let _span = tracing ::span! ( tracing ::Level ::INFO , " shard-manager " , rank = rank ) . entered ( ) ;
2023-04-26 12:43:36 +00:00
// Get UDS path
let uds_string = format! ( " {uds_path} - {rank} " ) ;
let uds = Path ::new ( & uds_string ) ;
// Clean previous runs
2023-07-13 12:22:37 +00:00
if uds . exists ( ) {
fs ::remove_file ( uds ) . unwrap ( ) ;
}
2023-04-26 12:43:36 +00:00
// Process args
2023-07-14 14:31:48 +00:00
let mut shard_args = vec! [
2023-04-26 12:43:36 +00:00
" serve " . to_string ( ) ,
model_id ,
" --uds-path " . to_string ( ) ,
uds_path ,
" --logger-level " . to_string ( ) ,
2024-05-23 13:40:40 +00:00
log_level . to_string ( ) . to_uppercase ( ) ,
2023-04-26 12:43:36 +00:00
" --json-output " . to_string ( ) ,
] ;
2023-05-23 18:40:39 +00:00
// Activate trust remote code
if trust_remote_code {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --trust-remote-code " . to_string ( ) ) ;
2023-05-23 18:40:39 +00:00
}
2023-04-26 12:43:36 +00:00
// Activate tensor parallelism
if world_size > 1 {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --sharded " . to_string ( ) ) ;
2023-02-15 15:11:32 +00:00
}
2023-05-12 12:46:41 +00:00
if let Some ( quantize ) = quantize {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --quantize " . to_string ( ) ) ;
shard_args . push ( quantize . to_string ( ) )
2023-04-26 12:43:36 +00:00
}
2023-02-15 15:11:32 +00:00
2023-12-11 11:46:30 +00:00
if let Some ( speculate ) = speculate {
shard_args . push ( " --speculate " . to_string ( ) ) ;
shard_args . push ( speculate . to_string ( ) )
}
2023-06-30 18:30:09 +00:00
if let Some ( dtype ) = dtype {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --dtype " . to_string ( ) ) ;
shard_args . push ( dtype . to_string ( ) )
2023-06-30 18:30:09 +00:00
}
2023-04-26 12:43:36 +00:00
// Model optional revision
if let Some ( revision ) = revision {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --revision " . to_string ( ) ) ;
shard_args . push ( revision )
2023-04-26 12:43:36 +00:00
}
2022-10-18 13:19:03 +00:00
2023-07-31 13:38:47 +00:00
let rope = match ( rope_scaling , rope_factor ) {
( None , None ) = > None ,
( Some ( scaling ) , None ) = > Some ( ( scaling , 1.0 ) ) ,
( Some ( scaling ) , Some ( factor ) ) = > Some ( ( scaling , factor ) ) ,
( None , Some ( factor ) ) = > Some ( ( RopeScaling ::Linear , factor ) ) ,
} ;
2024-04-26 13:44:44 +00:00
2023-04-26 12:43:36 +00:00
// OpenTelemetry
if let Some ( otlp_endpoint ) = otlp_endpoint {
2023-07-14 14:31:48 +00:00
shard_args . push ( " --otlp-endpoint " . to_string ( ) ) ;
shard_args . push ( otlp_endpoint ) ;
2023-04-26 12:43:36 +00:00
}
2024-06-10 07:09:50 +00:00
// In case we use sliding window, we may ignore the sliding in flash for some backends depending on the parameter.
shard_args . push ( " --max-input-tokens " . to_string ( ) ) ;
shard_args . push ( max_input_tokens . to_string ( ) ) ;
2023-04-26 12:43:36 +00:00
// Copy current process env
2023-07-14 14:31:48 +00:00
let mut envs : Vec < ( OsString , OsString ) > = env ::vars_os ( ) . collect ( ) ;
2023-04-26 12:43:36 +00:00
2024-04-10 15:20:25 +00:00
// Remove LOG_LEVEL if present
envs . retain ( | ( name , _ ) | name ! = " LOG_LEVEL " ) ;
2023-04-26 12:43:36 +00:00
// Torch Distributed Env vars
2023-07-14 14:31:48 +00:00
envs . push ( ( " RANK " . into ( ) , rank . to_string ( ) . into ( ) ) ) ;
envs . push ( ( " WORLD_SIZE " . into ( ) , world_size . to_string ( ) . into ( ) ) ) ;
envs . push ( ( " MASTER_ADDR " . into ( ) , master_addr . into ( ) ) ) ;
envs . push ( ( " MASTER_PORT " . into ( ) , master_port . to_string ( ) . into ( ) ) ) ;
2024-02-12 09:09:29 +00:00
envs . push ( ( " TORCH_NCCL_AVOID_RECORD_STREAMS " . into ( ) , " 1 " . into ( ) ) ) ;
2023-04-26 12:43:36 +00:00
2023-07-24 09:43:58 +00:00
// CUDA memory fraction
envs . push ( (
" CUDA_MEMORY_FRACTION " . into ( ) ,
cuda_memory_fraction . to_string ( ) . into ( ) ,
) ) ;
2023-04-26 12:43:36 +00:00
// Safetensors load fast
2023-07-14 14:31:48 +00:00
envs . push ( ( " SAFETENSORS_FAST_GPU " . into ( ) , " 1 " . into ( ) ) ) ;
2023-04-26 12:43:36 +00:00
2024-01-25 17:16:03 +00:00
// Disable progress bar
envs . push ( ( " HF_HUB_DISABLE_PROGRESS_BARS " . into ( ) , " 1 " . into ( ) ) ) ;
2023-04-26 12:43:36 +00:00
// Enable hf transfer for insane download speeds
let enable_hf_transfer = env ::var ( " HF_HUB_ENABLE_HF_TRANSFER " ) . unwrap_or ( " 1 " . to_string ( ) ) ;
2023-07-14 14:31:48 +00:00
envs . push ( (
2023-04-26 12:43:36 +00:00
" HF_HUB_ENABLE_HF_TRANSFER " . into ( ) ,
enable_hf_transfer . into ( ) ,
) ) ;
// Parse Inference API token
if let Ok ( api_token ) = env ::var ( " HF_API_TOKEN " ) {
2023-07-14 14:31:48 +00:00
envs . push ( ( " HUGGING_FACE_HUB_TOKEN " . into ( ) , api_token . into ( ) ) )
2023-04-26 12:43:36 +00:00
} ;
2023-07-31 13:38:47 +00:00
// Detect rope scaling
// Sending as env instead of CLI args to not bloat everything
// those only can be used by RoPE models, so passing information around
// for all models will complexify code unnecessarily
if let Some ( ( scaling , factor ) ) = rope {
envs . push ( ( " ROPE_SCALING " . into ( ) , scaling . to_string ( ) . into ( ) ) ) ;
envs . push ( ( " ROPE_FACTOR " . into ( ) , factor . to_string ( ) . into ( ) ) ) ;
}
2024-04-26 13:44:44 +00:00
envs . push ( (
" MAX_TOTAL_TOKENS " . into ( ) ,
max_total_tokens . to_string ( ) . into ( ) ,
) ) ;
if let Some ( max_batch_size ) = max_batch_size {
envs . push ( ( " MAX_BATCH_SIZE " . into ( ) , max_batch_size . to_string ( ) . into ( ) ) ) ;
}
2024-06-06 23:49:07 +00:00
// Lora Adapters
if let Some ( lora_adapters ) = lora_adapters {
envs . push ( ( " LORA_ADAPTERS " . into ( ) , lora_adapters . into ( ) ) ) ;
}
2023-04-26 12:43:36 +00:00
// If huggingface_hub_cache is some, pass it to the shard
// Useful when running inside a docker container
if let Some ( huggingface_hub_cache ) = huggingface_hub_cache {
2023-07-14 14:31:48 +00:00
envs . push ( ( " HUGGINGFACE_HUB_CACHE " . into ( ) , huggingface_hub_cache . into ( ) ) ) ;
2023-04-26 12:43:36 +00:00
} ;
// If weights_cache_override is some, pass it to the shard
// Useful when running inside a HuggingFace Inference Endpoint
if let Some ( weights_cache_override ) = weights_cache_override {
2023-07-14 14:31:48 +00:00
envs . push ( (
2023-04-26 12:43:36 +00:00
" WEIGHTS_CACHE_OVERRIDE " . into ( ) ,
weights_cache_override . into ( ) ,
) ) ;
} ;
2024-02-12 09:09:29 +00:00
// Enable experimental support for cuda graphs
2024-04-04 21:01:56 +00:00
if ! cuda_graphs . is_empty ( ) {
envs . push ( (
" CUDA_GRAPHS " . into ( ) ,
cuda_graphs
. into_iter ( )
. map ( | c | c . to_string ( ) )
. collect ::< Vec < _ > > ( )
. join ( " , " )
. into ( ) ,
) ) ;
2024-02-12 09:09:29 +00:00
}
2023-04-26 12:43:36 +00:00
// If disable_custom_kernels is true, pass it to the shard as an env var
if disable_custom_kernels {
2023-07-14 14:31:48 +00:00
envs . push ( ( " DISABLE_CUSTOM_KERNELS " . into ( ) , " True " . into ( ) ) )
2023-04-26 12:43:36 +00:00
}
// Watermark Gamma
if let Some ( watermark_gamma ) = watermark_gamma {
2023-07-14 14:31:48 +00:00
envs . push ( ( " WATERMARK_GAMMA " . into ( ) , watermark_gamma . to_string ( ) . into ( ) ) )
2023-04-26 12:43:36 +00:00
}
// Watermark Delta
if let Some ( watermark_delta ) = watermark_delta {
2023-07-14 14:31:48 +00:00
envs . push ( ( " WATERMARK_DELTA " . into ( ) , watermark_delta . to_string ( ) . into ( ) ) )
2023-04-26 12:43:36 +00:00
}
// Start process
2023-07-19 07:31:25 +00:00
tracing ::info! ( " Starting shard " ) ;
2023-07-13 12:22:37 +00:00
let mut p = match Command ::new ( " text-generation-server " )
2023-07-14 14:31:48 +00:00
. args ( shard_args )
2024-04-10 15:20:25 +00:00
. env_clear ( )
2023-07-14 14:31:48 +00:00
. envs ( envs )
2023-07-13 12:22:37 +00:00
. stdout ( Stdio ::piped ( ) )
. stderr ( Stdio ::piped ( ) )
. process_group ( 0 )
. spawn ( )
{
2023-04-26 12:43:36 +00:00
Ok ( p ) = > p ,
Err ( err ) = > {
2023-07-13 12:22:37 +00:00
if err . kind ( ) = = io ::ErrorKind ::NotFound {
tracing ::error! ( " text-generation-server not found in PATH " ) ;
tracing ::error! ( " Please install it with `make install-server` " )
2023-07-17 17:03:07 +00:00
}
{
2023-07-13 12:22:37 +00:00
tracing ::error! ( " {} " , err ) ;
2023-03-08 10:06:59 +00:00
}
2023-07-13 12:22:37 +00:00
2023-07-17 17:03:07 +00:00
status_sender . send ( ShardStatus ::Failed ( rank ) ) . unwrap ( ) ;
2023-04-26 12:43:36 +00:00
return ;
}
} ;
// Redirect STDOUT to the console
2023-06-30 21:09:20 +00:00
let shard_stdout_reader = BufReader ::new ( p . stdout . take ( ) . unwrap ( ) ) ;
2023-07-17 17:03:07 +00:00
let shard_stderr_reader = BufReader ::new ( p . stderr . take ( ) . unwrap ( ) ) ;
2023-04-26 12:43:36 +00:00
2023-07-17 17:03:07 +00:00
//stdout tracing thread
2023-04-26 12:43:36 +00:00
thread ::spawn ( move | | {
2023-07-17 17:03:07 +00:00
log_lines ( shard_stdout_reader . lines ( ) ) ;
2023-04-26 12:43:36 +00:00
} ) ;
2024-01-25 17:16:03 +00:00
// We read stderr in another thread as it seems that lines() can block in some cases
let ( err_sender , err_receiver ) = mpsc ::channel ( ) ;
thread ::spawn ( move | | {
2024-03-29 18:17:24 +00:00
for line in shard_stderr_reader . lines ( ) . map_while ( Result ::ok ) {
2024-01-25 17:16:03 +00:00
err_sender . send ( line ) . unwrap_or ( ( ) ) ;
}
} ) ;
2023-04-26 12:43:36 +00:00
let mut ready = false ;
let start_time = Instant ::now ( ) ;
let mut wait_time = Instant ::now ( ) ;
loop {
// Process exited
2023-07-13 12:22:37 +00:00
if let Some ( exit_status ) = p . try_wait ( ) . unwrap ( ) {
2023-07-17 17:03:07 +00:00
let mut err = String ::new ( ) ;
while let Ok ( line ) = err_receiver . recv_timeout ( Duration ::from_millis ( 10 ) ) {
err = err + " \n " + & line ;
}
2023-06-30 21:09:20 +00:00
2023-07-17 17:03:07 +00:00
tracing ::error! ( " Shard complete standard error output: \n {err} " ) ;
2023-06-02 12:17:27 +00:00
2023-07-13 12:22:37 +00:00
if let Some ( signal ) = exit_status . signal ( ) {
2023-06-02 12:17:27 +00:00
tracing ::error! ( " Shard process was signaled to shutdown with signal {signal} " ) ;
}
2023-07-17 17:03:07 +00:00
status_sender . send ( ShardStatus ::Failed ( rank ) ) . unwrap ( ) ;
2023-04-26 12:43:36 +00:00
return ;
}
// We received a shutdown signal
2023-06-30 21:09:20 +00:00
if shutdown . load ( Ordering ::SeqCst ) {
2024-04-29 15:23:40 +00:00
terminate ( " shard " , p , Duration ::from_secs ( 90 ) ) . unwrap ( ) ;
2023-04-26 12:43:36 +00:00
return ;
}
// Shard is ready
if uds . exists ( ) & & ! ready {
2023-07-19 07:31:25 +00:00
tracing ::info! ( " Shard ready in {:?} " , start_time . elapsed ( ) ) ;
2023-04-26 12:43:36 +00:00
status_sender . send ( ShardStatus ::Ready ) . unwrap ( ) ;
ready = true ;
} else if ! ready & & wait_time . elapsed ( ) > Duration ::from_secs ( 10 ) {
2023-07-19 07:31:25 +00:00
tracing ::info! ( " Waiting for shard to be ready... " ) ;
2023-04-26 12:43:36 +00:00
wait_time = Instant ::now ( ) ;
}
sleep ( Duration ::from_millis ( 100 ) ) ;
}
}
2023-06-30 21:09:20 +00:00
fn shutdown_shards ( shutdown : Arc < AtomicBool > , shutdown_receiver : & mpsc ::Receiver < ( ) > ) {
2023-04-26 12:43:36 +00:00
tracing ::info! ( " Shutting down shards " ) ;
// Update shutdown value to true
// This will be picked up by the shard manager
2023-06-30 21:09:20 +00:00
shutdown . store ( true , Ordering ::SeqCst ) ;
2023-04-26 12:43:36 +00:00
// Wait for shards to shutdown
// This will block till all shutdown_sender are dropped
let _ = shutdown_receiver . recv ( ) ;
}
fn num_cuda_devices ( ) -> Option < usize > {
2023-05-30 11:27:48 +00:00
let devices = match env ::var ( " CUDA_VISIBLE_DEVICES " ) {
Ok ( devices ) = > devices ,
Err ( _ ) = > env ::var ( " NVIDIA_VISIBLE_DEVICES " ) . ok ( ) ? ,
} ;
2023-05-30 10:52:18 +00:00
let n_devices = devices . split ( ',' ) . count ( ) ;
Some ( n_devices )
2023-04-26 12:43:36 +00:00
}
#[ derive(Deserialize) ]
#[ serde(rename_all = " UPPERCASE " ) ]
enum PythonLogLevelEnum {
Trace ,
Debug ,
Info ,
Success ,
Warning ,
Error ,
Critical ,
}
#[ derive(Deserialize) ]
struct PythonLogLevel {
name : PythonLogLevelEnum ,
}
#[ derive(Deserialize) ]
struct PythonLogRecord {
level : PythonLogLevel ,
}
#[ derive(Deserialize) ]
struct PythonLogMessage {
text : String ,
record : PythonLogRecord ,
}
impl PythonLogMessage {
fn trace ( & self ) {
match self . record . level . name {
2024-05-23 13:40:40 +00:00
PythonLogLevelEnum ::Trace = > tracing ::trace! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Debug = > tracing ::debug! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Info = > tracing ::info! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Success = > tracing ::info! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Warning = > tracing ::warn! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Error = > tracing ::error! ( " {} " , self . text . trim_end ( ) ) ,
PythonLogLevelEnum ::Critical = > tracing ::error! ( " {} " , self . text . trim_end ( ) ) ,
2023-04-26 12:43:36 +00:00
}
}
}
2023-07-17 17:03:07 +00:00
impl TryFrom < & String > for PythonLogMessage {
type Error = serde_json ::Error ;
fn try_from ( value : & String ) -> Result < Self , Self ::Error > {
serde_json ::from_str ::< Self > ( value )
}
}
fn log_lines < S : Sized + BufRead > ( lines : Lines < S > ) {
2024-03-29 18:17:24 +00:00
for line in lines . map_while ( Result ::ok ) {
2023-07-17 17:03:07 +00:00
match PythonLogMessage ::try_from ( & line ) {
Ok ( log ) = > log . trace ( ) ,
Err ( _ ) = > tracing ::debug! ( " {line} " ) ,
}
}
}
2023-07-13 12:22:37 +00:00
fn find_num_shards (
sharded : Option < bool > ,
num_shard : Option < usize > ,
) -> Result < usize , LauncherError > {
2023-04-26 12:43:36 +00:00
// get the number of shards given `sharded` and `num_shard`
let num_shard = match ( sharded , num_shard ) {
( Some ( true ) , None ) = > {
// try to default to the number of available GPUs
2023-05-30 10:52:18 +00:00
tracing ::info! ( " Parsing num_shard from CUDA_VISIBLE_DEVICES/NVIDIA_VISIBLE_DEVICES " ) ;
let n_devices = num_cuda_devices ( )
. expect ( " --num-shard and CUDA_VISIBLE_DEVICES/NVIDIA_VISIBLE_DEVICES are not set " ) ;
2023-04-26 12:43:36 +00:00
if n_devices < = 1 {
2023-07-13 12:22:37 +00:00
return Err ( LauncherError ::NotEnoughCUDADevices ( format! (
" `sharded` is true but only found {n_devices} CUDA devices "
) ) ) ;
2023-03-08 10:06:59 +00:00
}
2023-04-26 12:43:36 +00:00
n_devices
2023-03-08 10:06:59 +00:00
}
2023-04-26 12:43:36 +00:00
( Some ( true ) , Some ( num_shard ) ) = > {
// we can't have only one shard while sharded
if num_shard < = 1 {
2023-07-13 12:22:37 +00:00
return Err ( LauncherError ::ArgumentValidation (
" `sharded` is true but `num_shard` <= 1 " . to_string ( ) ,
) ) ;
2023-04-26 12:43:36 +00:00
}
num_shard
2023-03-08 12:53:41 +00:00
}
2023-04-26 12:43:36 +00:00
( Some ( false ) , Some ( num_shard ) ) = > num_shard ,
( Some ( false ) , None ) = > 1 ,
( None , None ) = > num_cuda_devices ( ) . unwrap_or ( 1 ) ,
( None , Some ( num_shard ) ) = > num_shard ,
2023-03-08 10:06:59 +00:00
} ;
2023-03-08 12:53:41 +00:00
if num_shard < 1 {
2023-07-13 12:22:37 +00:00
return Err ( LauncherError ::ArgumentValidation (
" `num_shard` cannot be < 1 " . to_string ( ) ,
) ) ;
2023-03-08 12:53:41 +00:00
}
2023-07-13 12:22:37 +00:00
Ok ( num_shard )
2023-04-26 12:43:36 +00:00
}
2023-03-08 12:53:41 +00:00
2024-05-06 11:48:11 +00:00
#[ derive(Debug, Error) ]
2023-04-26 12:43:36 +00:00
enum LauncherError {
2024-05-06 11:48:11 +00:00
#[ error( " Invalid argument: {0} " ) ]
2023-07-13 12:22:37 +00:00
ArgumentValidation ( String ) ,
2024-05-06 11:48:11 +00:00
#[ error( " not enough cuda devices: {0} " ) ]
2023-07-13 12:22:37 +00:00
NotEnoughCUDADevices ( String ) ,
2024-05-06 11:48:11 +00:00
#[ error( " Download error " ) ]
2023-04-26 12:43:36 +00:00
DownloadError ,
2024-05-06 11:48:11 +00:00
#[ error( " Shard cannot start " ) ]
2023-04-26 12:43:36 +00:00
ShardCannotStart ,
2024-05-06 11:48:11 +00:00
#[ error( " Shard disconnected " ) ]
2023-04-26 12:43:36 +00:00
ShardDisconnected ,
2024-05-06 11:48:11 +00:00
#[ error( " Shard failed " ) ]
2023-04-26 12:43:36 +00:00
ShardFailed ,
2024-05-06 11:48:11 +00:00
#[ error( " Webserver failed " ) ]
2023-04-26 12:43:36 +00:00
WebserverFailed ,
2024-05-06 11:48:11 +00:00
#[ error( " Webserver cannot start " ) ]
2023-04-26 12:43:36 +00:00
WebserverCannotStart ,
}
2022-10-18 13:19:03 +00:00
2023-06-01 10:10:35 +00:00
fn download_convert_model ( args : & Args , running : Arc < AtomicBool > ) -> Result < ( ) , LauncherError > {
2023-07-17 17:03:07 +00:00
// Enter download tracing span
let _span = tracing ::span! ( tracing ::Level ::INFO , " download " ) . entered ( ) ;
2023-07-14 14:31:48 +00:00
let mut download_args = vec! [
2023-04-26 12:43:36 +00:00
" download-weights " . to_string ( ) ,
args . model_id . to_string ( ) ,
" --extension " . to_string ( ) ,
" .safetensors " . to_string ( ) ,
" --logger-level " . to_string ( ) ,
" INFO " . to_string ( ) ,
" --json-output " . to_string ( ) ,
] ;
2023-03-06 13:39:36 +00:00
2023-04-26 12:43:36 +00:00
// Model optional revision
if let Some ( revision ) = & args . revision {
2023-07-14 14:31:48 +00:00
download_args . push ( " --revision " . to_string ( ) ) ;
download_args . push ( revision . to_string ( ) )
2023-04-26 12:43:36 +00:00
}
2023-02-14 12:02:16 +00:00
feat(server): Add native support for PEFT Lora models (#762)
- Will detect `peft` model by finding `adapter_config.json`.
- This triggers a totally dedicated `download-weights` path
- This path, loads the adapter config, finds the base model_id
- It loads the base_model
- Then peft_model
- Then `merge_and_unload()`
- Then `save_pretrained(.., safe_serialization=True)
- Add back the config + tokenizer.merge_and_unload()`
- Then `save_pretrained(.., safe_serialization=True)
- Add back the config + tokenizer.
- The chosen location is a **local folder with the name of the user
chosen model id**
PROs:
- Easier than to expect user to merge manually
- Barely any change outside of `download-weights` command.
- This means everything will work in a single load.
- Should enable out of the box SM + HFE
CONs:
- Creates a local merged model in unusual location, potentially
not saved across docker reloads, or ovewriting some files if the PEFT
itself was local and containing other files in addition to the lora
Alternatives considered:
- Add `local_files_only=True` every where (discard because of massive
code change for not a good enough reason)
- Return something to `launcher` about the new model-id (a cleaner
location for this new model), but it would
introduce new communication somewhere where we didn't need it before.
- Using the HF cache folder and *stopping* the flow after
`download-weights` and asking user to restart with the actual local
model location
Fix #482
# 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
-->
2023-08-03 15:22:45 +00:00
// Trust remote code for automatic peft fusion
if args . trust_remote_code {
download_args . push ( " --trust-remote-code " . to_string ( ) ) ;
}
2023-04-26 12:43:36 +00:00
// Copy current process env
2023-07-14 14:31:48 +00:00
let mut envs : Vec < ( OsString , OsString ) > = env ::vars_os ( ) . collect ( ) ;
2023-02-14 12:02:16 +00:00
2024-04-10 15:20:25 +00:00
// Remove LOG_LEVEL if present
envs . retain ( | ( name , _ ) | name ! = " LOG_LEVEL " ) ;
2024-01-25 17:16:03 +00:00
// Disable progress bar
envs . push ( ( " HF_HUB_DISABLE_PROGRESS_BARS " . into ( ) , " 1 " . into ( ) ) ) ;
2023-05-03 21:39:35 +00:00
// If huggingface_hub_cache is set, pass it to the download process
2023-04-26 12:43:36 +00:00
// Useful when running inside a docker container
if let Some ( ref huggingface_hub_cache ) = args . huggingface_hub_cache {
2023-07-14 14:31:48 +00:00
envs . push ( ( " HUGGINGFACE_HUB_CACHE " . into ( ) , huggingface_hub_cache . into ( ) ) ) ;
2023-04-26 12:43:36 +00:00
} ;
2023-02-14 12:02:16 +00:00
2023-04-26 12:43:36 +00:00
// Enable hf transfer for insane download speeds
let enable_hf_transfer = env ::var ( " HF_HUB_ENABLE_HF_TRANSFER " ) . unwrap_or ( " 1 " . to_string ( ) ) ;
2023-07-14 14:31:48 +00:00
envs . push ( (
2023-04-26 12:43:36 +00:00
" HF_HUB_ENABLE_HF_TRANSFER " . into ( ) ,
enable_hf_transfer . into ( ) ,
) ) ;
2023-04-09 18:00:05 +00:00
2023-04-26 12:43:36 +00:00
// Parse Inference API token
if let Ok ( api_token ) = env ::var ( " HF_API_TOKEN " ) {
2023-07-14 14:31:48 +00:00
envs . push ( ( " HUGGING_FACE_HUB_TOKEN " . into ( ) , api_token . into ( ) ) )
2023-04-26 12:43:36 +00:00
} ;
2023-02-18 13:04:11 +00:00
2023-05-03 21:39:35 +00:00
// If args.weights_cache_override is some, pass it to the download process
// Useful when running inside a HuggingFace Inference Endpoint
if let Some ( weights_cache_override ) = & args . weights_cache_override {
2023-07-14 14:31:48 +00:00
envs . push ( (
2023-05-03 21:39:35 +00:00
" WEIGHTS_CACHE_OVERRIDE " . into ( ) ,
weights_cache_override . into ( ) ,
) ) ;
} ;
2023-04-26 12:43:36 +00:00
// Start process
tracing ::info! ( " Starting download process. " ) ;
2023-07-13 12:22:37 +00:00
let mut download_process = match Command ::new ( " text-generation-server " )
2023-07-14 14:31:48 +00:00
. args ( download_args )
2024-04-10 15:20:25 +00:00
. env_clear ( )
2023-07-14 14:31:48 +00:00
. envs ( envs )
2023-07-13 12:22:37 +00:00
. stdout ( Stdio ::piped ( ) )
. stderr ( Stdio ::piped ( ) )
. process_group ( 0 )
. spawn ( )
{
2023-04-26 12:43:36 +00:00
Ok ( p ) = > p ,
Err ( err ) = > {
2023-07-13 12:22:37 +00:00
if err . kind ( ) = = io ::ErrorKind ::NotFound {
tracing ::error! ( " text-generation-server not found in PATH " ) ;
tracing ::error! ( " Please install it with `make install-server` " )
2023-07-17 17:03:07 +00:00
} else {
tracing ::error! ( " {} " , err ) ;
2023-02-14 12:02:16 +00:00
}
2023-07-13 12:22:37 +00:00
2023-04-26 12:43:36 +00:00
return Err ( LauncherError ::DownloadError ) ;
}
} ;
2023-02-14 12:02:16 +00:00
2024-01-25 17:16:03 +00:00
let download_stdout = BufReader ::new ( download_process . stdout . take ( ) . unwrap ( ) ) ;
2023-07-17 17:03:07 +00:00
2023-04-26 12:43:36 +00:00
thread ::spawn ( move | | {
2024-01-25 17:16:03 +00:00
log_lines ( download_stdout . lines ( ) ) ;
} ) ;
let download_stderr = BufReader ::new ( download_process . stderr . take ( ) . unwrap ( ) ) ;
// We read stderr in another thread as it seems that lines() can block in some cases
let ( err_sender , err_receiver ) = mpsc ::channel ( ) ;
thread ::spawn ( move | | {
2024-03-29 18:17:24 +00:00
for line in download_stderr . lines ( ) . map_while ( Result ::ok ) {
2024-01-25 17:16:03 +00:00
err_sender . send ( line ) . unwrap_or ( ( ) ) ;
}
2023-04-26 12:43:36 +00:00
} ) ;
2023-02-14 12:02:16 +00:00
2023-04-26 12:43:36 +00:00
loop {
2023-07-13 12:22:37 +00:00
if let Some ( status ) = download_process . try_wait ( ) . unwrap ( ) {
if status . success ( ) {
tracing ::info! ( " Successfully downloaded weights. " ) ;
break ;
2023-02-14 12:02:16 +00:00
}
2023-07-13 12:22:37 +00:00
let mut err = String ::new ( ) ;
2024-01-25 17:16:03 +00:00
while let Ok ( line ) = err_receiver . recv_timeout ( Duration ::from_millis ( 10 ) ) {
err = err + " \n " + & line ;
}
2023-07-13 12:22:37 +00:00
if let Some ( signal ) = status . signal ( ) {
tracing ::error! (
" Download process was signaled to shutdown with signal {signal}: {err} "
) ;
} else {
tracing ::error! ( " Download encountered an error: {err} " ) ;
}
return Err ( LauncherError ::DownloadError ) ;
2023-02-14 12:02:16 +00:00
}
2023-04-26 12:43:36 +00:00
if ! running . load ( Ordering ::SeqCst ) {
2023-07-14 14:31:48 +00:00
terminate ( " download " , download_process , Duration ::from_secs ( 10 ) ) . unwrap ( ) ;
2023-04-26 12:43:36 +00:00
return Ok ( ( ) ) ;
}
sleep ( Duration ::from_millis ( 100 ) ) ;
2023-02-14 12:02:16 +00:00
}
2023-04-26 12:43:36 +00:00
Ok ( ( ) )
}
2023-02-14 12:02:16 +00:00
2023-04-26 18:23:54 +00:00
#[ allow(clippy::too_many_arguments) ]
2023-04-26 12:43:36 +00:00
fn spawn_shards (
num_shard : usize ,
args : & Args ,
2024-04-12 12:20:31 +00:00
cuda_graphs : Vec < usize > ,
2024-04-26 13:44:44 +00:00
max_total_tokens : usize ,
2024-06-10 07:09:50 +00:00
max_input_tokens : usize ,
2024-05-23 13:40:40 +00:00
max_log_level : LevelFilter ,
2023-06-30 21:09:20 +00:00
shutdown : Arc < AtomicBool > ,
2023-04-26 12:43:36 +00:00
shutdown_receiver : & mpsc ::Receiver < ( ) > ,
shutdown_sender : mpsc ::Sender < ( ) > ,
status_receiver : & mpsc ::Receiver < ShardStatus > ,
status_sender : mpsc ::Sender < ShardStatus > ,
running : Arc < AtomicBool > ,
) -> Result < ( ) , LauncherError > {
2022-10-18 13:19:03 +00:00
// Start shard processes
for rank in 0 .. num_shard {
2023-04-26 12:43:36 +00:00
let model_id = args . model_id . clone ( ) ;
let revision = args . revision . clone ( ) ;
let uds_path = args . shard_uds_path . clone ( ) ;
let master_addr = args . master_addr . clone ( ) ;
let huggingface_hub_cache = args . huggingface_hub_cache . clone ( ) ;
let weights_cache_override = args . weights_cache_override . clone ( ) ;
2022-10-18 13:19:03 +00:00
let status_sender = status_sender . clone ( ) ;
let shutdown = shutdown . clone ( ) ;
let shutdown_sender = shutdown_sender . clone ( ) ;
2023-04-26 12:43:36 +00:00
let otlp_endpoint = args . otlp_endpoint . clone ( ) ;
2023-04-26 18:23:54 +00:00
let quantize = args . quantize ;
2023-12-11 11:46:30 +00:00
let speculate = args . speculate ;
2023-06-30 18:30:09 +00:00
let dtype = args . dtype ;
2023-05-23 18:40:39 +00:00
let trust_remote_code = args . trust_remote_code ;
2023-04-26 18:23:54 +00:00
let master_port = args . master_port ;
let disable_custom_kernels = args . disable_custom_kernels ;
let watermark_gamma = args . watermark_gamma ;
let watermark_delta = args . watermark_delta ;
2024-04-12 12:20:31 +00:00
let cuda_graphs_clone = cuda_graphs . clone ( ) ;
2023-07-24 09:43:58 +00:00
let cuda_memory_fraction = args . cuda_memory_fraction ;
2023-07-31 13:38:47 +00:00
let rope_scaling = args . rope_scaling ;
let rope_factor = args . rope_factor ;
2024-04-26 13:44:44 +00:00
let max_batch_size = args . max_batch_size ;
2024-06-06 23:49:07 +00:00
let lora_adapters = args . lora_adapters . clone ( ) ;
2022-10-18 13:19:03 +00:00
thread ::spawn ( move | | {
shard_manager (
2023-02-03 11:43:37 +00:00
model_id ,
2023-01-31 17:53:56 +00:00
revision ,
2022-10-27 12:25:29 +00:00
quantize ,
2023-12-11 11:46:30 +00:00
speculate ,
2023-06-30 18:30:09 +00:00
dtype ,
2023-05-23 18:40:39 +00:00
trust_remote_code ,
2022-10-18 13:19:03 +00:00
uds_path ,
rank ,
num_shard ,
master_addr ,
master_port ,
2023-02-14 12:02:16 +00:00
huggingface_hub_cache ,
weights_cache_override ,
2023-02-15 15:23:45 +00:00
disable_custom_kernels ,
2023-03-02 11:30:41 +00:00
watermark_gamma ,
watermark_delta ,
2024-04-12 12:20:31 +00:00
cuda_graphs_clone ,
2023-07-24 09:43:58 +00:00
cuda_memory_fraction ,
2023-07-31 13:38:47 +00:00
rope_scaling ,
rope_factor ,
2024-04-26 13:44:44 +00:00
max_total_tokens ,
max_batch_size ,
2024-06-10 07:09:50 +00:00
max_input_tokens ,
2024-06-06 23:49:07 +00:00
lora_adapters ,
2023-02-13 12:02:45 +00:00
otlp_endpoint ,
2024-05-23 13:40:40 +00:00
max_log_level ,
2022-10-18 13:19:03 +00:00
status_sender ,
shutdown ,
shutdown_sender ,
)
} ) ;
}
drop ( shutdown_sender ) ;
// Wait for shard to start
let mut shard_ready = 0 ;
while running . load ( Ordering ::SeqCst ) {
match status_receiver . try_recv ( ) {
Ok ( ShardStatus ::Ready ) = > {
shard_ready + = 1 ;
if shard_ready = = num_shard {
break ;
}
}
Err ( TryRecvError ::Empty ) = > {
sleep ( Duration ::from_millis ( 100 ) ) ;
}
2023-07-17 17:03:07 +00:00
Ok ( ShardStatus ::Failed ( rank ) ) = > {
2023-06-30 21:09:20 +00:00
tracing ::error! ( " Shard {rank} failed to start " ) ;
2023-04-26 18:23:54 +00:00
shutdown_shards ( shutdown , shutdown_receiver ) ;
2023-04-26 12:43:36 +00:00
return Err ( LauncherError ::ShardCannotStart ) ;
2022-10-18 13:19:03 +00:00
}
Err ( TryRecvError ::Disconnected ) = > {
tracing ::error! ( " Shard status channel disconnected " ) ;
2023-04-26 18:23:54 +00:00
shutdown_shards ( shutdown , shutdown_receiver ) ;
2023-04-26 12:43:36 +00:00
return Err ( LauncherError ::ShardDisconnected ) ;
2022-10-18 13:19:03 +00:00
}
}
}
2023-04-26 12:43:36 +00:00
Ok ( ( ) )
}
2022-10-18 13:19:03 +00:00
2024-01-29 11:30:50 +00:00
fn compute_type ( num_shard : usize ) -> Option < String > {
let output = Command ::new ( " nvidia-smi " )
. args ( [ " --query-gpu=gpu_name " , " --format=csv " ] )
. output ( )
. ok ( ) ? ;
let output = String ::from_utf8 ( output . stdout ) . ok ( ) ? ;
let fullname = output . split ( '\n' ) . nth ( 1 ) ? ;
let cardname = fullname . replace ( ' ' , " - " ) . to_lowercase ( ) ;
let compute_type = format! ( " {num_shard} - {cardname} " ) ;
Some ( compute_type )
}
2023-04-26 12:43:36 +00:00
fn spawn_webserver (
2024-01-29 11:30:50 +00:00
num_shard : usize ,
2023-04-26 12:43:36 +00:00
args : Args ,
2024-04-12 12:20:31 +00:00
max_input_tokens : usize ,
max_total_tokens : usize ,
max_batch_prefill_tokens : u32 ,
2023-06-30 21:09:20 +00:00
shutdown : Arc < AtomicBool > ,
2023-04-26 12:43:36 +00:00
shutdown_receiver : & mpsc ::Receiver < ( ) > ,
2023-07-13 12:22:37 +00:00
) -> Result < Child , LauncherError > {
2022-10-18 13:19:03 +00:00
// All shard started
// Start webserver
tracing ::info! ( " Starting Webserver " ) ;
2023-07-14 14:31:48 +00:00
let mut router_args = vec! [
2024-04-17 08:41:12 +00:00
" --max-client-batch-size " . to_string ( ) ,
args . max_client_batch_size . to_string ( ) ,
2022-11-02 16:29:56 +00:00
" --max-concurrent-requests " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . max_concurrent_requests . to_string ( ) ,
2023-03-09 14:30:54 +00:00
" --max-best-of " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . max_best_of . to_string ( ) ,
2023-03-03 15:01:25 +00:00
" --max-stop-sequences " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . max_stop_sequences . to_string ( ) ,
2023-08-28 09:43:47 +00:00
" --max-top-n-tokens " . to_string ( ) ,
args . max_top_n_tokens . to_string ( ) ,
2024-04-12 12:20:31 +00:00
" --max-input-tokens " . to_string ( ) ,
max_input_tokens . to_string ( ) ,
2023-03-03 15:01:25 +00:00
" --max-total-tokens " . to_string ( ) ,
2024-04-12 12:20:31 +00:00
max_total_tokens . to_string ( ) ,
2023-06-30 17:09:59 +00:00
" --max-batch-prefill-tokens " . to_string ( ) ,
2024-04-12 12:20:31 +00:00
max_batch_prefill_tokens . to_string ( ) ,
2023-04-24 15:59:00 +00:00
" --waiting-served-ratio " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . waiting_served_ratio . to_string ( ) ,
2022-11-02 16:29:56 +00:00
" --max-waiting-tokens " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . max_waiting_tokens . to_string ( ) ,
2023-07-13 12:22:37 +00:00
" --validation-workers " . to_string ( ) ,
args . validation_workers . to_string ( ) ,
2023-07-05 16:28:45 +00:00
" --hostname " . to_string ( ) ,
args . hostname . to_string ( ) ,
2022-11-02 16:29:56 +00:00
" --port " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . port . to_string ( ) ,
2022-11-02 16:29:56 +00:00
" --master-shard-uds-path " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
format! ( " {} -0 " , args . shard_uds_path ) ,
2022-11-02 16:29:56 +00:00
" --tokenizer-name " . to_string ( ) ,
2023-04-26 12:43:36 +00:00
args . model_id ,
2022-11-02 16:29:56 +00:00
] ;
2024-02-15 09:28:10 +00:00
// Grammar support
if args . disable_grammar_support {
router_args . push ( " --disable-grammar-support " . to_string ( ) ) ;
}
2024-01-26 17:01:33 +00:00
// Tokenizer config path
if let Some ( ref tokenizer_config_path ) = args . tokenizer_config_path {
router_args . push ( " --tokenizer-config-path " . to_string ( ) ) ;
router_args . push ( tokenizer_config_path . to_string ( ) ) ;
}
2023-07-19 07:31:25 +00:00
// Model optional max batch total tokens
if let Some ( max_batch_total_tokens ) = args . max_batch_total_tokens {
router_args . push ( " --max-batch-total-tokens " . to_string ( ) ) ;
router_args . push ( max_batch_total_tokens . to_string ( ) ) ;
}
2024-02-09 11:38:41 +00:00
// Router optional max batch size
if let Some ( max_batch_size ) = args . max_batch_size {
router_args . push ( " --max-batch-size " . to_string ( ) ) ;
router_args . push ( max_batch_size . to_string ( ) ) ;
}
2023-04-26 12:43:36 +00:00
// Model optional revision
if let Some ( ref revision ) = args . revision {
2023-07-14 14:31:48 +00:00
router_args . push ( " --revision " . to_string ( ) ) ;
router_args . push ( revision . to_string ( ) )
2022-10-27 12:25:29 +00:00
}
2023-04-26 12:43:36 +00:00
if args . json_output {
2023-07-14 14:31:48 +00:00
router_args . push ( " --json-output " . to_string ( ) ) ;
2023-01-31 17:53:56 +00:00
}
2023-02-13 12:02:45 +00:00
// OpenTelemetry
2023-04-26 12:43:36 +00:00
if let Some ( otlp_endpoint ) = args . otlp_endpoint {
2023-07-14 14:31:48 +00:00
router_args . push ( " --otlp-endpoint " . to_string ( ) ) ;
router_args . push ( otlp_endpoint ) ;
2023-04-26 12:43:36 +00:00
}
// CORS origins
for origin in args . cors_allow_origin . into_iter ( ) {
2023-07-14 14:31:48 +00:00
router_args . push ( " --cors-allow-origin " . to_string ( ) ) ;
router_args . push ( origin ) ;
2023-02-13 12:02:45 +00:00
}
2023-06-16 14:25:11 +00:00
// Ngrok
if args . ngrok {
2023-07-14 14:31:48 +00:00
router_args . push ( " --ngrok " . to_string ( ) ) ;
router_args . push ( " --ngrok-authtoken " . to_string ( ) ) ;
2023-07-19 09:59:58 +00:00
router_args . push ( args . ngrok_authtoken . unwrap ( ) ) ;
router_args . push ( " --ngrok-edge " . to_string ( ) ) ;
router_args . push ( args . ngrok_edge . unwrap ( ) ) ;
2023-06-16 14:25:11 +00:00
}
2023-02-16 10:20:23 +00:00
// Copy current process env
2023-07-14 14:31:48 +00:00
let mut envs : Vec < ( OsString , OsString ) > = env ::vars_os ( ) . collect ( ) ;
2023-02-16 10:20:23 +00:00
2023-04-09 18:00:05 +00:00
// Parse Inference API token
if let Ok ( api_token ) = env ::var ( " HF_API_TOKEN " ) {
2023-07-14 14:31:48 +00:00
envs . push ( ( " HUGGING_FACE_HUB_TOKEN " . into ( ) , api_token . into ( ) ) )
2023-04-09 18:00:05 +00:00
} ;
2023-02-18 13:04:11 +00:00
2024-01-29 11:30:50 +00:00
// Parse Compute type
if let Ok ( compute_type ) = env ::var ( " COMPUTE_TYPE " ) {
envs . push ( ( " COMPUTE_TYPE " . into ( ) , compute_type . into ( ) ) )
} else if let Some ( compute_type ) = compute_type ( num_shard ) {
envs . push ( ( " COMPUTE_TYPE " . into ( ) , compute_type . into ( ) ) )
}
2023-07-13 12:22:37 +00:00
let mut webserver = match Command ::new ( " text-generation-router " )
2023-07-14 14:31:48 +00:00
. args ( router_args )
. envs ( envs )
2023-07-13 12:22:37 +00:00
. stdout ( Stdio ::piped ( ) )
. stderr ( Stdio ::piped ( ) )
. process_group ( 0 )
. spawn ( )
{
2022-10-18 13:19:03 +00:00
Ok ( p ) = > p ,
Err ( err ) = > {
2023-04-26 12:43:36 +00:00
tracing ::error! ( " Failed to start webserver: {} " , err ) ;
2023-07-13 12:22:37 +00:00
if err . kind ( ) = = io ::ErrorKind ::NotFound {
tracing ::error! ( " text-generation-router not found in PATH " ) ;
tracing ::error! ( " Please install it with `make install-router` " )
2023-04-26 12:43:36 +00:00
} else {
tracing ::error! ( " {} " , err ) ;
2022-10-18 13:19:03 +00:00
}
2023-04-26 12:43:36 +00:00
2023-04-26 18:23:54 +00:00
shutdown_shards ( shutdown , shutdown_receiver ) ;
2023-04-26 12:43:36 +00:00
return Err ( LauncherError ::WebserverCannotStart ) ;
2022-10-18 13:19:03 +00:00
}
} ;
2023-04-26 12:43:36 +00:00
// Redirect STDOUT and STDERR to the console
let webserver_stdout = webserver . stdout . take ( ) . unwrap ( ) ;
let webserver_stderr = webserver . stderr . take ( ) . unwrap ( ) ;
2023-01-05 11:01:23 +00:00
thread ::spawn ( move | | {
2023-04-26 12:43:36 +00:00
let stdout = BufReader ::new ( webserver_stdout ) ;
let stderr = BufReader ::new ( webserver_stderr ) ;
2023-01-05 11:01:23 +00:00
for line in stdout . lines ( ) {
2023-04-26 12:43:36 +00:00
println! ( " {} " , line . unwrap ( ) ) ;
2023-01-05 11:01:23 +00:00
}
2023-04-26 12:43:36 +00:00
for line in stderr . lines ( ) {
println! ( " {} " , line . unwrap ( ) ) ;
2022-10-18 13:19:03 +00:00
}
2023-04-26 12:43:36 +00:00
} ) ;
Ok ( webserver )
}
2022-10-18 13:19:03 +00:00
2023-07-14 14:31:48 +00:00
fn terminate ( process_name : & str , mut process : Child , timeout : Duration ) -> io ::Result < ExitStatus > {
tracing ::info! ( " Terminating {process_name} " ) ;
let terminate_time = Instant ::now ( ) ;
signal ::kill ( Pid ::from_raw ( process . id ( ) as i32 ) , Signal ::SIGTERM ) . unwrap ( ) ;
tracing ::info! ( " Waiting for {process_name} to gracefully shutdown " ) ;
while terminate_time . elapsed ( ) < timeout {
if let Some ( status ) = process . try_wait ( ) ? {
tracing ::info! ( " {process_name} terminated " ) ;
return Ok ( status ) ;
}
sleep ( Duration ::from_millis ( 100 ) ) ;
}
tracing ::info! ( " Killing {process_name} " ) ;
process . kill ( ) ? ;
let exit_status = process . wait ( ) ? ;
tracing ::info! ( " {process_name} killed " ) ;
Ok ( exit_status )
}
2023-04-26 12:43:36 +00:00
fn main ( ) -> Result < ( ) , LauncherError > {
// Pattern match configuration
2023-07-19 09:59:58 +00:00
let args : Args = Args ::parse ( ) ;
2022-10-18 13:19:03 +00:00
2023-07-17 17:03:07 +00:00
// Filter events with LOG_LEVEL
2024-05-23 13:40:40 +00:00
let varname = " LOG_LEVEL " ;
let env_filter = if let Ok ( log_level ) = std ::env ::var ( varname ) {
// Override to avoid simple logs to be spammed with tokio level informations
let log_level = match & log_level [ .. ] {
" warn " = > " text_generation_launcher=warn,text_generation_router=warn " ,
" info " = > " text_generation_launcher=info,text_generation_router=info " ,
" debug " = > " text_generation_launcher=debug,text_generation_router=debug " ,
log_level = > log_level ,
} ;
EnvFilter ::builder ( )
. with_default_directive ( LevelFilter ::INFO . into ( ) )
. parse_lossy ( log_level )
} else {
EnvFilter ::new ( " info " )
} ;
let max_log_level = env_filter . max_level_hint ( ) . unwrap_or ( LevelFilter ::INFO ) ;
2023-07-17 17:03:07 +00:00
2023-04-26 12:43:36 +00:00
if args . json_output {
2023-07-17 17:03:07 +00:00
tracing_subscriber ::fmt ( )
. with_env_filter ( env_filter )
. json ( )
. init ( ) ;
2023-04-26 12:43:36 +00:00
} else {
2023-07-17 17:03:07 +00:00
tracing_subscriber ::fmt ( )
. with_env_filter ( env_filter )
. compact ( )
. init ( ) ;
2022-10-18 13:19:03 +00:00
}
2023-05-02 13:43:19 +00:00
if args . env {
let env_runtime = env_runtime ::Env ::new ( ) ;
tracing ::info! ( " {} " , env_runtime ) ;
}
2024-04-30 09:39:38 +00:00
tracing ::info! ( " {:#?} " , args ) ;
2023-04-26 12:43:36 +00:00
2024-04-12 12:20:31 +00:00
let get_max_position_embeddings = | | -> Result < usize , Box < dyn std ::error ::Error > > {
let model_id = args . model_id . clone ( ) ;
let mut path = std ::path ::Path ::new ( & args . model_id ) . to_path_buf ( ) ;
let filename = if ! path . exists ( ) {
// Assume it's a hub id
let api = Api ::new ( ) ? ;
let repo = if let Some ( ref revision ) = args . revision {
api . repo ( Repo ::with_revision (
model_id ,
RepoType ::Model ,
revision . to_string ( ) ,
) )
} else {
api . model ( model_id )
} ;
repo . get ( " config.json " ) ?
} else {
path . push ( " config.json " ) ;
path
} ;
let content = std ::fs ::read_to_string ( filename ) ? ;
2024-05-23 12:39:38 +00:00
let config : RawConfig = serde_json ::from_str ( & content ) ? ;
let config : Config = config . into ( ) ;
2024-04-12 12:20:31 +00:00
// Quantization usually means you're even more RAM constrained.
let max_default = 4096 ;
2024-05-23 12:39:38 +00:00
if let Some ( max_position_embeddings ) = config . max_position_embeddings {
if max_position_embeddings > max_default {
let max = max_position_embeddings ;
if args . max_input_tokens . is_none ( )
& & args . max_total_tokens . is_none ( )
& & args . max_batch_prefill_tokens . is_none ( )
{
tracing ::info! ( " Model supports up to {max} but tgi will now set its default to {max_default} instead. This is to save VRAM by refusing large prompts in order to allow more users on the same hardware. You can increase that size using `--max-batch-prefill-tokens={} --max-total-tokens={max} --max-input-tokens={}`. " , max + 50 , max - 1 ) ;
2024-04-12 12:20:31 +00:00
}
2024-05-23 12:39:38 +00:00
Ok ( max_default )
} else {
Ok ( max_position_embeddings )
2024-04-12 12:20:31 +00:00
}
2024-05-23 12:39:38 +00:00
} else {
Err ( Box ::new ( LauncherError ::ArgumentValidation (
" no max defined " . to_string ( ) ,
) ) )
}
2024-04-12 12:20:31 +00:00
} ;
let max_position_embeddings : usize = get_max_position_embeddings ( ) . unwrap_or ( 4096 ) ;
let max_input_tokens = {
match ( args . max_input_tokens , args . max_input_length ) {
( Some ( max_input_tokens ) , Some ( max_input_length ) ) = > {
return Err ( LauncherError ::ArgumentValidation (
format! ( " Both `max_input_tokens` ( {max_input_tokens} ) and `max_input_length` ( {max_input_length} ) are set. Please define only `max_input_tokens` as `max_input_length is deprecated for naming consistency. " ,
) ) ) ;
}
( Some ( max_input_tokens ) , None ) | ( None , Some ( max_input_tokens ) ) = > max_input_tokens ,
( None , None ) = > {
let value = max_position_embeddings - 1 ;
tracing ::info! ( " Default `max_input_tokens` to {value} " ) ;
value
}
}
} ;
let max_total_tokens = {
match args . max_total_tokens {
Some ( max_total_tokens ) = > max_total_tokens ,
None = > {
let value = max_position_embeddings ;
tracing ::info! ( " Default `max_total_tokens` to {value} " ) ;
value
}
}
} ;
let max_batch_prefill_tokens = {
match args . max_batch_prefill_tokens {
Some ( max_batch_prefill_tokens ) = > max_batch_prefill_tokens ,
None = > {
let value : u32 = if let Some ( max_batch_size ) = args . max_batch_size {
max_batch_size * max_input_tokens
} else {
// Adding some edge in order to account for potential block_size alignement
// issue.
max_input_tokens + 50
} as u32 ;
tracing ::info! ( " Default `max_batch_prefill_tokens` to {value} " ) ;
value
}
}
} ;
2023-07-13 12:22:37 +00:00
// Validate args
2024-04-12 12:20:31 +00:00
if max_input_tokens > = max_total_tokens {
2023-07-13 12:22:37 +00:00
return Err ( LauncherError ::ArgumentValidation (
2024-04-12 12:20:31 +00:00
" `max_input_tokens must be < `max_total_tokens` " . to_string ( ) ,
2023-07-13 12:22:37 +00:00
) ) ;
}
2024-04-12 12:20:31 +00:00
if max_input_tokens as u32 > max_batch_prefill_tokens {
2023-07-13 12:22:37 +00:00
return Err ( LauncherError ::ArgumentValidation ( format! (
2024-04-12 12:20:31 +00:00
" `max_batch_prefill_tokens` must be >= `max_input_tokens`. Given: {} and {} " ,
max_batch_prefill_tokens , max_input_tokens
2023-07-13 12:22:37 +00:00
) ) ) ;
}
2023-07-19 07:31:25 +00:00
2024-04-12 12:20:31 +00:00
let cuda_graphs = match ( & args . cuda_graphs , & args . quantize ) {
2024-04-30 09:39:38 +00:00
( Some ( cuda_graphs ) , _ ) = > cuda_graphs . iter ( ) . cloned ( ) . filter ( | & c | c > 0 ) . collect ( ) ,
2024-04-12 12:20:31 +00:00
#[ allow(deprecated) ]
(
None ,
Some (
Quantization ::Bitsandbytes
| Quantization ::BitsandbytesNF4
| Quantization ::BitsandbytesFP4 ,
) ,
) = > {
tracing ::info! ( " Bitsandbytes doesn't work with cuda graphs, deactivating them " ) ;
vec! [ ]
}
_ = > {
let cuda_graphs = vec! [ 1 , 2 , 4 , 8 , 16 , 32 ] ;
tracing ::info! ( " Using default cuda graphs {cuda_graphs:?} " ) ;
cuda_graphs
}
} ;
2023-07-13 12:22:37 +00:00
if args . validation_workers = = 0 {
return Err ( LauncherError ::ArgumentValidation (
" `validation_workers` must be > 0 " . to_string ( ) ,
) ) ;
}
2023-07-13 16:59:38 +00:00
if args . trust_remote_code {
tracing ::warn! (
" `trust_remote_code` is set. Trusting that model `{}` do not contain malicious code. " ,
args . model_id
) ;
}
2023-07-13 12:22:37 +00:00
let num_shard = find_num_shards ( args . sharded , args . num_shard ) ? ;
2023-04-26 12:43:36 +00:00
if num_shard > 1 {
2024-05-28 09:51:31 +00:00
if matches! ( args . quantize , Some ( Quantization ::Exl2 ) ) {
return Err ( LauncherError ::ArgumentValidation (
" Sharding is currently not supported with `exl2` quantization " . into ( ) ,
) ) ;
}
2023-04-26 12:43:36 +00:00
tracing ::info! ( " Sharding model on {num_shard} processes " ) ;
2022-10-18 13:19:03 +00:00
}
2023-07-19 07:31:25 +00:00
if let Some ( ref max_batch_total_tokens ) = args . max_batch_total_tokens {
2024-04-12 12:20:31 +00:00
if max_batch_prefill_tokens > * max_batch_total_tokens {
2023-07-19 07:31:25 +00:00
return Err ( LauncherError ::ArgumentValidation ( format! (
" `max_batch_prefill_tokens` must be <= `max_batch_total_tokens`. Given: {} and {} " ,
2024-04-12 12:20:31 +00:00
max_batch_prefill_tokens , max_batch_total_tokens
2023-07-19 07:31:25 +00:00
) ) ) ;
}
2024-04-12 12:20:31 +00:00
if max_total_tokens as u32 > * max_batch_total_tokens {
2023-07-19 07:31:25 +00:00
return Err ( LauncherError ::ArgumentValidation ( format! (
" `max_total_tokens` must be <= `max_batch_total_tokens`. Given: {} and {} " ,
2024-04-12 12:20:31 +00:00
max_total_tokens , max_batch_total_tokens
2023-07-19 07:31:25 +00:00
) ) ) ;
}
}
2023-07-19 09:59:58 +00:00
if args . ngrok {
if args . ngrok_authtoken . is_none ( ) {
return Err ( LauncherError ::ArgumentValidation (
" `ngrok-authtoken` must be set when using ngrok tunneling " . to_string ( ) ,
) ) ;
}
if args . ngrok_edge . is_none ( ) {
return Err ( LauncherError ::ArgumentValidation (
" `ngrok-edge` must be set when using ngrok tunneling " . to_string ( ) ,
) ) ;
}
}
2023-04-26 12:43:36 +00:00
// Signal handler
let running = Arc ::new ( AtomicBool ::new ( true ) ) ;
let r = running . clone ( ) ;
ctrlc ::set_handler ( move | | {
r . store ( false , Ordering ::SeqCst ) ;
} )
. expect ( " Error setting Ctrl-C handler " ) ;
2023-03-08 12:53:41 +00:00
2023-05-03 09:36:24 +00:00
// Download and convert model weights
2023-06-01 10:10:35 +00:00
download_convert_model ( & args , running . clone ( ) ) ? ;
2023-04-16 22:26:47 +00:00
2023-07-14 14:31:48 +00:00
if ! running . load ( Ordering ::SeqCst ) {
// Launcher was asked to stop
return Ok ( ( ) ) ;
}
2023-04-26 12:43:36 +00:00
// Shared shutdown bool
2023-06-30 21:09:20 +00:00
let shutdown = Arc ::new ( AtomicBool ::new ( false ) ) ;
2023-04-26 12:43:36 +00:00
// Shared shutdown channel
// When shutting down, the main thread will wait for all senders to be dropped
let ( shutdown_sender , shutdown_receiver ) = mpsc ::channel ( ) ;
2023-04-16 22:26:47 +00:00
2023-04-26 12:43:36 +00:00
// Shared channel to track shard status
let ( status_sender , status_receiver ) = mpsc ::channel ( ) ;
2023-04-16 22:26:47 +00:00
2023-04-26 12:43:36 +00:00
spawn_shards (
num_shard ,
& args ,
2024-04-12 12:20:31 +00:00
cuda_graphs ,
2024-04-26 13:44:44 +00:00
max_total_tokens ,
2024-06-10 07:09:50 +00:00
max_input_tokens ,
2024-05-23 13:40:40 +00:00
max_log_level ,
2023-04-26 12:43:36 +00:00
shutdown . clone ( ) ,
& shutdown_receiver ,
shutdown_sender ,
& status_receiver ,
status_sender ,
running . clone ( ) ,
) ? ;
2023-04-16 22:26:47 +00:00
2023-04-26 12:43:36 +00:00
// We might have received a termination signal
if ! running . load ( Ordering ::SeqCst ) {
shutdown_shards ( shutdown , & shutdown_receiver ) ;
return Ok ( ( ) ) ;
}
2023-04-16 22:26:47 +00:00
2024-04-12 12:20:31 +00:00
let mut webserver = spawn_webserver (
num_shard ,
args ,
max_input_tokens ,
max_total_tokens ,
max_batch_prefill_tokens ,
shutdown . clone ( ) ,
& shutdown_receiver ,
)
. map_err ( | err | {
shutdown_shards ( shutdown . clone ( ) , & shutdown_receiver ) ;
err
} ) ? ;
2023-04-26 12:43:36 +00:00
// Default exit code
let mut exit_code = Ok ( ( ) ) ;
while running . load ( Ordering ::SeqCst ) {
2023-07-17 17:03:07 +00:00
if let Ok ( ShardStatus ::Failed ( rank ) ) = status_receiver . try_recv ( ) {
2023-07-01 17:25:41 +00:00
tracing ::error! ( " Shard {rank} crashed " ) ;
2023-04-26 12:43:36 +00:00
exit_code = Err ( LauncherError ::ShardFailed ) ;
break ;
} ;
2023-07-13 12:22:37 +00:00
match webserver . try_wait ( ) . unwrap ( ) {
2023-04-26 12:43:36 +00:00
Some ( _ ) = > {
tracing ::error! ( " Webserver Crashed " ) ;
shutdown_shards ( shutdown , & shutdown_receiver ) ;
return Err ( LauncherError ::WebserverFailed ) ;
}
None = > {
sleep ( Duration ::from_millis ( 100 ) ) ;
}
} ;
2023-04-16 22:26:47 +00:00
}
2023-04-26 12:43:36 +00:00
// Graceful termination
2023-07-14 14:31:48 +00:00
terminate ( " webserver " , webserver , Duration ::from_secs ( 90 ) ) . unwrap ( ) ;
2023-04-26 12:43:36 +00:00
shutdown_shards ( shutdown , & shutdown_receiver ) ;
exit_code
2023-04-16 22:26:47 +00:00
}