main.rs 24.9 KB
Newer Older
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
1
use clap::Parser;
2
use serde::Deserialize;
Nicolas Patry's avatar
Nicolas Patry committed
3
use std::env;
4
use std::ffi::OsString;
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
5
6
7
8
9
10
11
12
13
14
15
use std::io::{BufRead, BufReader, Read};
use std::path::Path;
use std::process::ExitCode;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::TryRecvError;
use std::sync::Arc;
use std::sync::{mpsc, Mutex};
use std::thread;
use std::thread::sleep;
use std::time::{Duration, Instant};
use std::{fs, io};
16
use subprocess::{ExitStatus, Popen, PopenConfig, PopenError, Redirection};
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
17
18
19
20
21
22

/// App Configuration
#[derive(Parser, Debug)]
#[clap(author, version, about, long_about = None)]
struct Args {
    #[clap(default_value = "bigscience/bloom-560m", long, env)]
23
    model_id: String,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
24
    #[clap(long, env)]
25
    revision: Option<String>,
26
27
28
29
    #[clap(long, env)]
    sharded: Option<bool>,
    #[clap(long, env)]
    num_shard: Option<usize>,
30
31
    #[clap(long, env)]
    quantize: bool,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
32
33
    #[clap(default_value = "128", long, env)]
    max_concurrent_requests: usize,
34
35
    #[clap(default_value = "2", long, env)]
    max_best_of: usize,
36
37
    #[clap(default_value = "4", long, env)]
    max_stop_sequences: usize,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
38
39
    #[clap(default_value = "1000", long, env)]
    max_input_length: usize,
40
41
    #[clap(default_value = "1512", long, env)]
    max_total_tokens: usize,
42
43
44
45
46
47
    #[clap(long, env)]
    max_batch_size: Option<usize>,
    #[clap(default_value = "1.2", long, env)]
    waiting_served_ratio: f32,
    #[clap(default_value = "32000", long, env)]
    max_batch_total_tokens: u32,
48
49
    #[clap(default_value = "20", long, env)]
    max_waiting_tokens: usize,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
50
51
52
53
    #[clap(default_value = "3000", long, short, env)]
    port: u16,
    #[clap(default_value = "/tmp/text-generation-server", long, env)]
    shard_uds_path: String,
54
    #[clap(default_value = "localhost", long, env)]
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
55
    master_addr: String,
56
    #[clap(default_value = "29500", long, env)]
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
57
    master_port: usize,
58
    #[clap(long, env)]
59
60
61
62
    huggingface_hub_cache: Option<String>,
    #[clap(long, env)]
    weights_cache_override: Option<String>,
    #[clap(long, env)]
63
64
    disable_custom_kernels: bool,
    #[clap(long, env)]
65
    json_output: bool,
66
67
    #[clap(long, env)]
    otlp_endpoint: Option<String>,
68
69
    #[clap(long, env)]
    cors_allow_origin: Vec<String>,
70
71
72
73
    #[clap(long, env)]
    watermark_gamma: Option<f32>,
    #[clap(long, env)]
    watermark_delta: Option<f32>,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
74
75
76
77
}

fn main() -> ExitCode {
    // Pattern match configuration
78
79
80
81
82
83
84
85
86
87
    let args = Args::parse();

    if args.json_output {
        tracing_subscriber::fmt().json().init();
    } else {
        tracing_subscriber::fmt().compact().init();
    }

    tracing::info!("{:?}", args);

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
88
    let Args {
89
        model_id,
90
        revision,
91
        sharded,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
92
        num_shard,
93
        quantize,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
94
        max_concurrent_requests,
95
        max_best_of,
96
        max_stop_sequences,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
97
        max_input_length,
98
        max_total_tokens,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
99
        max_batch_size,
100
101
        max_batch_total_tokens,
        waiting_served_ratio,
102
        max_waiting_tokens,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
103
104
105
106
        port,
        shard_uds_path,
        master_addr,
        master_port,
107
108
        huggingface_hub_cache,
        weights_cache_override,
109
        disable_custom_kernels,
110
        json_output,
111
        otlp_endpoint,
112
        cors_allow_origin,
113
114
        watermark_gamma,
        watermark_delta,
115
    } = args;
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
116

117
118
119
120
121
122
123
124
125
126
    // get the number of shards given `sharded` and `num_shard`
    let num_shard = if let Some(sharded) = sharded {
        // sharded is set
        match sharded {
            // sharded is set and true
            true => {
                match num_shard {
                    None => {
                        // try to default to the number of available GPUs
                        tracing::info!("Parsing num_shard from CUDA_VISIBLE_DEVICES");
127
                        let n_devices = num_cuda_devices()
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
                            .expect("--num-shard and CUDA_VISIBLE_DEVICES are not set");
                        if n_devices <= 1 {
                            panic!("`sharded` is true but only found {n_devices} CUDA devices");
                        }
                        n_devices
                    }
                    Some(num_shard) => {
                        // we can't have only one shard while sharded
                        if num_shard <= 1 {
                            panic!("`sharded` is true but `num_shard` <= 1");
                        }
                        num_shard
                    }
                }
            }
            // sharded is set and false
            false => {
                let num_shard = num_shard.unwrap_or(1);
                // we can't have more than one shard while not sharded
                if num_shard != 1 {
                    panic!("`sharded` is false but `num_shard` != 1");
                }
                num_shard
            }
        }
    } else {
154
155
156
157
158
        match num_shard {
            // get num_shard from CUDA_VISIBLE_DEVICES or default to a single shard
            None => num_cuda_devices().unwrap_or(1),
            Some(num_shard) => num_shard,
        }
159
    };
160
161
162
163
164
165
166
    if num_shard < 1 {
        panic!("`num_shard` cannot be < 1");
    }

    if num_shard > 1 {
        tracing::info!("Sharding model on {num_shard} processes");
    }
167

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
168
169
170
171
172
173
174
175
    // 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");

176
177
178
179
    // Check if model_id is a local model
    let local_path = Path::new(&model_id);
    let is_local_model = local_path.exists() && local_path.is_dir();

180
    // Download weights for sharded models
181
    if !is_local_model && weights_cache_override.is_none() && num_shard > 1 {
182
183
184
185
        let mut download_argv = vec![
            "text-generation-server".to_string(),
            "download-weights".to_string(),
            model_id.clone(),
186
187
            "--extension".to_string(),
            ".safetensors".to_string(),
188
189
190
191
192
193
194
195
196
197
198
            "--logger-level".to_string(),
            "INFO".to_string(),
            "--json-output".to_string(),
        ];

        // Model optional revision
        if let Some(ref revision) = revision {
            download_argv.push("--revision".to_string());
            download_argv.push(revision.to_string())
        }

199
200
        // Copy current process env
        let mut env: Vec<(OsString, OsString)> = env::vars_os().collect();
201

202
        // If huggingface_hub_cache is set, pass it to the shard
203
204
205
206
207
        // Useful when running inside a docker container
        if let Some(ref huggingface_hub_cache) = huggingface_hub_cache {
            env.push(("HUGGINGFACE_HUB_CACHE".into(), huggingface_hub_cache.into()));
        };

208
        // Enable hf transfer for insane download speeds
209
210
211
212
213
214
215
216
217
218
        let enable_hf_transfer = env::var("HF_HUB_ENABLE_HF_TRANSFER").unwrap_or("1".to_string());
        env.push((
            "HF_HUB_ENABLE_HF_TRANSFER".into(),
            enable_hf_transfer.into(),
        ));

        // Parse Inference API token
        if let Ok(api_token) = env::var("HF_API_TOKEN") {
            env.push(("HUGGING_FACE_HUB_TOKEN".into(), api_token.into()))
        };
219

220
        // Start process
221
        tracing::info!("Starting download process.");
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        let mut download_process = match Popen::create(
            &download_argv,
            PopenConfig {
                stdout: Redirection::Pipe,
                stderr: Redirection::Pipe,
                // Needed for the shutdown procedure
                setpgid: true,
                env: Some(env),
                ..Default::default()
            },
        ) {
            Ok(p) => p,
            Err(err) => {
                if let PopenError::IoError(ref err) = err {
                    if err.kind() == io::ErrorKind::NotFound {
                        tracing::error!("text-generation-server not found in PATH");
                        tracing::error!("Please install it with `make install-server`")
                    }
                }
                return ExitCode::FAILURE;
            }
        };

        // Redirect STDOUT to the console
        let download_stdout = download_process.stdout.take().unwrap();
        thread::spawn(move || {
            // Enter download tracing span
            let stdout = BufReader::new(download_stdout);
            let _span = tracing::span!(tracing::Level::INFO, "download").entered();
            for line in stdout.lines() {
                // Parse loguru logs
253
254
                if let Ok(log) = serde_json::from_str::<PythonLogMessage>(&line.unwrap()) {
                    log.trace();
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
                }
            }
        });

        loop {
            if let Some(status) = download_process.poll() {
                match status {
                    ExitStatus::Exited(exit_code) => {
                        if exit_code == 0 {
                            tracing::info!("Successfully downloaded weights.");
                            break;
                        } else {
                            let mut err = String::new();
                            download_process
                                .stderr
                                .take()
                                .unwrap()
                                .read_to_string(&mut err)
                                .unwrap();
                            tracing::error!("Download encountered an error: {err}");
                            return ExitCode::FAILURE;
                        }
                    }
                    _ => {
279
                        tracing::error!("Download process exited with an unknown status.");
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
                        return ExitCode::FAILURE;
                    }
                }
            }
            if !running.load(Ordering::SeqCst) {
                download_process.terminate().unwrap();
                tracing::info!("Waiting for download process to gracefully shutdown");
                download_process
                    .wait_timeout(Duration::from_secs(90))
                    .unwrap();
                tracing::info!("Download process terminated");
                return ExitCode::SUCCESS;
            }
            sleep(Duration::from_millis(100));
        }
    }

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
297
298
299
300
301
302
303
304
305
306
307
    // Shared shutdown bool
    let shutdown = Arc::new(Mutex::new(false));
    // Shared shutdown channel
    // When shutting down, the main thread will wait for all senders to be dropped
    let (shutdown_sender, shutdown_receiver) = mpsc::channel();

    // Shared channel to track shard status
    let (status_sender, status_receiver) = mpsc::channel();

    // Start shard processes
    for rank in 0..num_shard {
308
        let model_id = model_id.clone();
309
        let revision = revision.clone();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
310
311
        let uds_path = shard_uds_path.clone();
        let master_addr = master_addr.clone();
312
313
        let huggingface_hub_cache = huggingface_hub_cache.clone();
        let weights_cache_override = weights_cache_override.clone();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
314
315
316
        let status_sender = status_sender.clone();
        let shutdown = shutdown.clone();
        let shutdown_sender = shutdown_sender.clone();
317
        let otlp_endpoint = otlp_endpoint.clone();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
318
319
        thread::spawn(move || {
            shard_manager(
320
                model_id,
321
                revision,
322
                quantize,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
323
324
325
326
327
                uds_path,
                rank,
                num_shard,
                master_addr,
                master_port,
328
329
                huggingface_hub_cache,
                weights_cache_override,
330
                disable_custom_kernels,
331
332
                watermark_gamma,
                watermark_delta,
333
                otlp_endpoint,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
                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));
            }
355
356
            Ok(ShardStatus::Failed((rank, err))) => {
                tracing::error!("Shard {} failed to start:\n{}", rank, err);
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
                shutdown_shards(shutdown, &shutdown_receiver);
                return ExitCode::FAILURE;
            }
            Err(TryRecvError::Disconnected) => {
                tracing::error!("Shard status channel disconnected");
                shutdown_shards(shutdown, &shutdown_receiver);
                return ExitCode::FAILURE;
            }
        }
    }

    // We might have received a termination signal
    if !running.load(Ordering::SeqCst) {
        shutdown_shards(shutdown, &shutdown_receiver);
        return ExitCode::SUCCESS;
    }

    // All shard started
    // Start webserver
    tracing::info!("Starting Webserver");
377
378
379
380
    let mut argv = vec![
        "text-generation-router".to_string(),
        "--max-concurrent-requests".to_string(),
        max_concurrent_requests.to_string(),
381
382
        "--max-best-of".to_string(),
        max_best_of.to_string(),
383
384
        "--max-stop-sequences".to_string(),
        max_stop_sequences.to_string(),
385
386
        "--max-input-length".to_string(),
        max_input_length.to_string(),
387
388
        "--max-total-tokens".to_string(),
        max_total_tokens.to_string(),
389
390
        "--waiting-served-ratio".to_string(),
        waiting_served_ratio.to_string(),
391
392
393
394
395
        "--max-waiting-tokens".to_string(),
        max_waiting_tokens.to_string(),
        "--port".to_string(),
        port.to_string(),
        "--master-shard-uds-path".to_string(),
396
        format!("{shard_uds_path}-0"),
397
        "--tokenizer-name".to_string(),
398
        model_id,
399
400
    ];

401
402
403
404
405
406
407
408
409
    // Deprecate max_batch_size
    if let Some(max_batch_size) = max_batch_size {
        argv.push("--max-batch-size".to_string());
        argv.push(max_batch_size.to_string())
    } else {
        argv.push("--max-batch-total-tokens".to_string());
        argv.push(max_batch_total_tokens.to_string())
    }

410
411
412
413
414
415
    // Model optional revision
    if let Some(ref revision) = revision {
        argv.push("--revision".to_string());
        argv.push(revision.to_string())
    }

416
417
418
419
    if json_output {
        argv.push("--json-output".to_string());
    }

420
421
422
423
424
425
    // OpenTelemetry
    if let Some(otlp_endpoint) = otlp_endpoint {
        argv.push("--otlp-endpoint".to_string());
        argv.push(otlp_endpoint);
    }

426
427
428
429
430
431
    // CORS origins
    for origin in cors_allow_origin.into_iter() {
        argv.push("--cors-allow-origin".to_string());
        argv.push(origin);
    }

432
433
434
435
436
437
438
439
    // Copy current process env
    let mut env: Vec<(OsString, OsString)> = env::vars_os().collect();

    // Parse Inference API token
    if let Ok(api_token) = env::var("HF_API_TOKEN") {
        env.push(("HUGGING_FACE_HUB_TOKEN".into(), api_token.into()))
    };

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
440
    let mut webserver = match Popen::create(
441
        &argv,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
442
443
444
445
446
        PopenConfig {
            stdout: Redirection::Pipe,
            stderr: Redirection::Pipe,
            // Needed for the shutdown procedure
            setpgid: true,
447
            env: Some(env),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
448
449
450
451
452
453
454
455
456
457
458
            ..Default::default()
        },
    ) {
        Ok(p) => p,
        Err(err) => {
            tracing::error!("Failed to start webserver: {}", err);
            if let PopenError::IoError(err) = err {
                if err.kind() == io::ErrorKind::NotFound {
                    tracing::error!("text-generation-router not found in PATH");
                    tracing::error!("Please install it with `make install-router`")
                }
459
460
            } else {
                tracing::error!("{}", err);
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
            }

            shutdown_shards(shutdown, &shutdown_receiver);
            return ExitCode::FAILURE;
        }
    };

    // Redirect STDOUT and STDERR to the console
    let webserver_stdout = webserver.stdout.take().unwrap();
    let webserver_stderr = webserver.stderr.take().unwrap();

    thread::spawn(move || {
        let stdout = BufReader::new(webserver_stdout);
        let stderr = BufReader::new(webserver_stderr);
        for line in stdout.lines() {
            println!("{}", line.unwrap());
        }
        for line in stderr.lines() {
            println!("{}", line.unwrap());
        }
    });

    // Default exit code
    let mut exit_code = ExitCode::SUCCESS;

    while running.load(Ordering::SeqCst) {
487
488
        if let Ok(ShardStatus::Failed((rank, err))) = status_receiver.try_recv() {
            tracing::error!("Shard {rank} failed:\n{err}");
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
            exit_code = ExitCode::FAILURE;
            break;
        };

        match webserver.poll() {
            Some(_) => {
                tracing::error!("Webserver Crashed");
                shutdown_shards(shutdown, &shutdown_receiver);
                return ExitCode::FAILURE;
            }
            None => {
                sleep(Duration::from_millis(100));
            }
        };
    }

    // Graceful termination
    webserver.terminate().unwrap();
    tracing::info!("Waiting for webserver to gracefully shutdown");
    webserver.wait_timeout(Duration::from_secs(90)).unwrap();
    tracing::info!("Webserver terminated");
    shutdown_shards(shutdown, &shutdown_receiver);

    exit_code
}

#[derive(Debug)]
enum ShardStatus {
    Ready,
518
    Failed((usize, String)),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
519
520
521
522
}

#[allow(clippy::too_many_arguments)]
fn shard_manager(
523
    model_id: String,
524
    revision: Option<String>,
525
    quantize: bool,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
526
527
528
529
530
    uds_path: String,
    rank: usize,
    world_size: usize,
    master_addr: String,
    master_port: usize,
531
532
    huggingface_hub_cache: Option<String>,
    weights_cache_override: Option<String>,
533
    disable_custom_kernels: bool,
534
535
    watermark_gamma: Option<f32>,
    watermark_delta: Option<f32>,
536
    otlp_endpoint: Option<String>,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
537
538
539
540
541
    status_sender: mpsc::Sender<ShardStatus>,
    shutdown: Arc<Mutex<bool>>,
    _shutdown_sender: mpsc::Sender<()>,
) {
    // Get UDS path
542
    let uds_string = format!("{uds_path}-{rank}");
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
543
544
545
546
547
548
    let uds = Path::new(&uds_string);
    // Clean previous runs
    fs::remove_file(uds).unwrap_or_default();

    // Process args
    let mut shard_argv = vec![
549
        "text-generation-server".to_string(),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
550
        "serve".to_string(),
551
        model_id,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
552
553
        "--uds-path".to_string(),
        uds_path,
554
        "--logger-level".to_string(),
555
        "INFO".to_string(),
556
        "--json-output".to_string(),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
557
558
    ];

559
    // Activate tensor parallelism
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
560
561
562
563
    if world_size > 1 {
        shard_argv.push("--sharded".to_string());
    }

564
565
566
567
    if quantize {
        shard_argv.push("--quantize".to_string())
    }

568
    // Model optional revision
569
570
571
572
573
    if let Some(revision) = revision {
        shard_argv.push("--revision".to_string());
        shard_argv.push(revision)
    }

574
575
576
577
578
579
    // OpenTelemetry
    if let Some(otlp_endpoint) = otlp_endpoint {
        shard_argv.push("--otlp-endpoint".to_string());
        shard_argv.push(otlp_endpoint);
    }

580
581
582
583
584
585
586
587
588
589
590
591
    // Copy current process env
    let mut env: Vec<(OsString, OsString)> = env::vars_os().collect();

    // Torch Distributed Env vars
    env.push(("RANK".into(), rank.to_string().into()));
    env.push(("WORLD_SIZE".into(), world_size.to_string().into()));
    env.push(("MASTER_ADDR".into(), master_addr.into()));
    env.push(("MASTER_PORT".into(), master_port.to_string().into()));
    env.push(("NCCL_ASYNC_ERROR_HANDLING".into(), "1".into()));

    // Safetensors load fast
    env.push(("SAFETENSORS_FAST_GPU".into(), "1".into()));
Nicolas Patry's avatar
Nicolas Patry committed
592

593
    // Enable hf transfer for insane download speeds
594
595
596
597
598
599
600
601
602
603
    let enable_hf_transfer = env::var("HF_HUB_ENABLE_HF_TRANSFER").unwrap_or("1".to_string());
    env.push((
        "HF_HUB_ENABLE_HF_TRANSFER".into(),
        enable_hf_transfer.into(),
    ));

    // Parse Inference API token
    if let Ok(api_token) = env::var("HF_API_TOKEN") {
        env.push(("HUGGING_FACE_HUB_TOKEN".into(), api_token.into()))
    };
604

605
    // If huggingface_hub_cache is some, pass it to the shard
Nicolas Patry's avatar
Nicolas Patry committed
606
    // Useful when running inside a docker container
607
    if let Some(huggingface_hub_cache) = huggingface_hub_cache {
608
        env.push(("HUGGINGFACE_HUB_CACHE".into(), huggingface_hub_cache.into()));
Nicolas Patry's avatar
Nicolas Patry committed
609
    };
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
610

611
    // If weights_cache_override is some, pass it to the shard
612
    // Useful when running inside a HuggingFace Inference Endpoint
613
    if let Some(weights_cache_override) = weights_cache_override {
614
615
616
617
        env.push((
            "WEIGHTS_CACHE_OVERRIDE".into(),
            weights_cache_override.into(),
        ));
618
619
    };

620
621
622
623
624
    // If disable_custom_kernels is true, pass it to the shard as an env var
    if disable_custom_kernels {
        env.push(("DISABLE_CUSTOM_KERNELS".into(), "True".into()))
    }

625
626
627
628
629
630
631
632
633
634
    // Watermark Gamma
    if let Some(watermark_gamma) = watermark_gamma {
        env.push(("WATERMARK_GAMMA".into(), watermark_gamma.to_string().into()))
    }

    // Watermark Delta
    if let Some(watermark_delta) = watermark_delta {
        env.push(("WATERMARK_DELTA".into(), watermark_delta.to_string().into()))
    }

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
635
    // Start process
636
    tracing::info!("Starting shard {rank}");
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
637
638
639
640
641
642
643
644
    let mut p = match Popen::create(
        &shard_argv,
        PopenConfig {
            stdout: Redirection::Pipe,
            stderr: Redirection::Pipe,
            // Needed for the shutdown procedure
            setpgid: true,
            // NCCL env vars
Nicolas Patry's avatar
Nicolas Patry committed
645
            env: Some(env),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
646
647
648
649
650
651
652
            ..Default::default()
        },
    ) {
        Ok(p) => p,
        Err(err) => {
            if let PopenError::IoError(ref err) = err {
                if err.kind() == io::ErrorKind::NotFound {
653
                    tracing::error!("text-generation-server not found in PATH");
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
654
655
656
                    tracing::error!("Please install it with `make install-server`")
                }
            }
657
658
659
            status_sender
                .send(ShardStatus::Failed((rank, err.to_string())))
                .unwrap();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
660
661
662
663
            return;
        }
    };

664
665
666
667
668
669
670
671
672
    // Redirect STDOUT to the console
    let shard_stdout = p.stdout.take().unwrap();

    thread::spawn(move || {
        // Enter shard-manager tracing span
        let stdout = BufReader::new(shard_stdout);
        let _span = tracing::span!(tracing::Level::INFO, "shard-manager", rank = rank).entered();
        for line in stdout.lines() {
            // Parse loguru logs
673
674
            if let Ok(log) = serde_json::from_str::<PythonLogMessage>(&line.unwrap()) {
                log.trace();
675
676
677
678
            }
        }
    });

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
679
680
    let mut ready = false;
    let start_time = Instant::now();
Nicolas Patry's avatar
Nicolas Patry committed
681
    let mut wait_time = Instant::now();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
682
683
684
    loop {
        // Process exited
        if p.poll().is_some() {
685
686
687
688
689
            let mut err = String::new();
            p.stderr.take().unwrap().read_to_string(&mut err).unwrap();
            status_sender
                .send(ShardStatus::Failed((rank, err)))
                .unwrap();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
690
691
692
693
694
695
696
            return;
        }

        // We received a shutdown signal
        if *shutdown.lock().unwrap() {
            p.terminate().unwrap();
            let _ = p.wait_timeout(Duration::from_secs(90));
697
            tracing::info!("Shard {rank} terminated");
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
698
699
700
701
702
            return;
        }

        // Shard is ready
        if uds.exists() && !ready {
703
            tracing::info!("Shard {rank} ready in {:?}", start_time.elapsed());
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
704
705
            status_sender.send(ShardStatus::Ready).unwrap();
            ready = true;
706
        } else if !ready && wait_time.elapsed() > Duration::from_secs(10) {
707
            tracing::info!("Waiting for shard {rank} to be ready...");
708
            wait_time = Instant::now();
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
709
        }
Nicolas Patry's avatar
Nicolas Patry committed
710
        sleep(Duration::from_millis(100));
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
    }
}

fn shutdown_shards(shutdown: Arc<Mutex<bool>>, shutdown_receiver: &mpsc::Receiver<()>) {
    tracing::info!("Shutting down shards");
    // Update shutdown value to true
    // This will be picked up by the shard manager
    {
        let mut shutdown = shutdown.lock().unwrap();
        *shutdown = true;
    }

    // Wait for shards to shutdown
    // This will block till all shutdown_sender are dropped
    let _ = shutdown_receiver.recv();
}
727
728
729
730
731
732
733
734

fn num_cuda_devices() -> Option<usize> {
    if let Ok(cuda_visible_devices) = env::var("CUDA_VISIBLE_DEVICES") {
        let n_devices = cuda_visible_devices.split(',').count();
        return Some(n_devices);
    }
    None
}
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776

#[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 {
            PythonLogLevelEnum::Trace => tracing::trace!("{}", self.text),
            PythonLogLevelEnum::Debug => tracing::debug!("{}", self.text),
            PythonLogLevelEnum::Info => tracing::info!("{}", self.text),
            PythonLogLevelEnum::Success => tracing::info!("{}", self.text),
            PythonLogLevelEnum::Warning => tracing::warn!("{}", self.text),
            PythonLogLevelEnum::Error => tracing::error!("{}", self.text),
            PythonLogLevelEnum::Critical => tracing::error!("{}", self.text),
        }
    }
}