validation.rs 33.6 KB
Newer Older
1
use crate::config::Config;
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
2
/// Payload validation logic
3
use crate::validation::ValidationError::{BestOfSampling, BestOfSeed, EmptyInput};
drbh's avatar
drbh committed
4
use crate::{GenerateParameters, GenerateRequest, GrammarType};
5
use jsonschema::{Draft, JSONSchema};
6
use rand::{thread_rng, Rng};
7
use serde_json::Value;
8
use std::io::Cursor;
drbh's avatar
drbh committed
9
10
11
use text_generation_client::{
    GrammarType as ProtoGrammarType, NextTokenChooserParameters, StoppingCriteriaParameters,
};
Olivier Dehaene's avatar
Olivier Dehaene committed
12
use thiserror::Error;
Olivier Dehaene's avatar
Olivier Dehaene committed
13
use tokenizers::tokenizer::Tokenizer;
14
15
16
// use tokenizers::TruncationDirection;
use base64::{engine::general_purpose::STANDARD, Engine};
use image::{io::Reader as ImageReader, ImageFormat};
OlivierDehaene's avatar
OlivierDehaene committed
17
use tokio::sync::mpsc;
18
use tokio::sync::oneshot;
19
use tracing::{instrument, Span};
20
use {once_cell::sync::Lazy, regex::Regex};
Olivier Dehaene's avatar
Olivier Dehaene committed
21

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
22
/// Validation
Olivier Dehaene's avatar
Olivier Dehaene committed
23
#[derive(Debug, Clone)]
Olivier Dehaene's avatar
Olivier Dehaene committed
24
pub struct Validation {
25
    /// Validation parameters
26
    max_best_of: usize,
27
    max_stop_sequences: usize,
Nicolas Patry's avatar
Nicolas Patry committed
28
    max_top_n_tokens: u32,
29
30
    max_input_length: usize,
    max_total_tokens: usize,
drbh's avatar
drbh committed
31
    disable_grammar_support: bool,
32
    /// Channel to communicate with the background tokenization task
OlivierDehaene's avatar
OlivierDehaene committed
33
    sender: Option<mpsc::UnboundedSender<TokenizerRequest>>,
Olivier Dehaene's avatar
Olivier Dehaene committed
34
35
36
}

impl Validation {
OlivierDehaene's avatar
OlivierDehaene committed
37
    #[allow(clippy::too_many_arguments)]
38
39
    pub(crate) fn new(
        workers: usize,
40
        tokenizer: Option<Tokenizer>,
41
        config: Option<Config>,
42
        max_best_of: usize,
43
        max_stop_sequences: usize,
Nicolas Patry's avatar
Nicolas Patry committed
44
        max_top_n_tokens: u32,
45
46
        max_input_length: usize,
        max_total_tokens: usize,
drbh's avatar
drbh committed
47
        disable_grammar_support: bool,
48
    ) -> Self {
49
50
        // If we have a fast tokenizer
        let sender = if let Some(tokenizer) = tokenizer {
OlivierDehaene's avatar
OlivierDehaene committed
51
52
53
            // Create round robin channel
            let (validation_sender, validation_round_robin_receiver) = mpsc::unbounded_channel();
            let mut senders = Vec::with_capacity(workers);
54
55
56
57

            // Create workers
            for _ in 0..workers {
                let tokenizer_clone = tokenizer.clone();
58
                let config_clone = config.clone();
OlivierDehaene's avatar
OlivierDehaene committed
59
60
                let (tokenizer_sender, tokenizer_receiver) = mpsc::unbounded_channel();
                senders.push(tokenizer_sender);
61
62
63

                // Spawn worker
                tokio::task::spawn_blocking(move || {
64
                    tokenizer_worker(tokenizer_clone, config_clone, tokenizer_receiver)
65
66
                });
            }
OlivierDehaene's avatar
OlivierDehaene committed
67
68
69
70

            // Create tokenization round robin task
            tokio::spawn(round_robin_task(validation_round_robin_receiver, senders));

71
72
73
74
75
76
77
78
            Some(validation_sender)
        } else {
            None
        };

        Self {
            max_best_of,
            sender,
79
            max_stop_sequences,
Nicolas Patry's avatar
Nicolas Patry committed
80
            max_top_n_tokens,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
81
            max_input_length,
82
            max_total_tokens,
drbh's avatar
drbh committed
83
            disable_grammar_support,
84
85
        }
    }
Olivier Dehaene's avatar
Olivier Dehaene committed
86

87
    #[instrument(skip(self, inputs))]
88
    pub async fn tokenize(
89
90
91
        &self,
        inputs: String,
        truncate: Option<usize>,
92
    ) -> Result<Option<(tokenizers::Encoding, String)>, ValidationError> {
93
94
95
96
97
98
99
100
101
102
103
104
        // If we have a fast tokenizer
        if let Some(sender) = &self.sender {
            // Create response channel
            let (response_sender, response_receiver) = oneshot::channel();
            // Send request to the background validation task
            // Unwrap is safe here
            sender
                .send(((inputs, truncate), response_sender, Span::current()))
                .unwrap();

            // Await on response channel
            // Unwrap is safe here
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
            let encoding = response_receiver.await.unwrap()?;
            Ok(Some(encoding))
        } else {
            Ok(None)
        }
    }

    #[instrument(skip(self, inputs))]
    async fn validate_input(
        &self,
        inputs: String,
        truncate: Option<usize>,
        max_new_tokens: Option<u32>,
    ) -> Result<(String, usize, u32), ValidationError> {
        // If we have a fast tokenizer
        if let Some((encoding, inputs)) = self.tokenize(inputs.clone(), truncate).await? {
            // Create response channel
Nicolas Patry's avatar
Nicolas Patry committed
122
123
124
125
126
            let input_length = if let Some(truncate) = truncate {
                std::cmp::min(encoding.len(), truncate)
            } else {
                encoding.len()
            };
127
128

            // Get total tokens
129
130
131
132
133
            let max_new_tokens: u32 = if let Some(max_new_tokens) = max_new_tokens {
                max_new_tokens
            } else {
                self.max_total_tokens.saturating_sub(input_length) as u32
            };
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
            let total_tokens = input_length + max_new_tokens as usize;

            // Validate MaxTotalTokens
            if total_tokens > self.max_total_tokens {
                return Err(ValidationError::MaxTotalTokens(
                    self.max_total_tokens,
                    input_length,
                    max_new_tokens,
                ));
            }

            // Validate InputLength
            if input_length > self.max_input_length {
                return Err(ValidationError::InputLength(
                    self.max_input_length,
                    input_length,
                ));
            }

            metrics::histogram!("tgi_request_input_length", input_length as f64);
154
            Ok((inputs, input_length, max_new_tokens))
155
156
157
158
159
160
        }
        // Return inputs without validation
        else {
            // In this case, we don't know the real length in tokens of the inputs
            // However, the inputs will be truncated by the python servers
            // We make sure that truncate + max_new_tokens <= self.max_total_tokens
161
162
            let max_new_tokens: u32 = if let Some(max_new_tokens) = max_new_tokens {
                max_new_tokens
OlivierDehaene's avatar
OlivierDehaene committed
163
164
            } else if let Some(truncate) = truncate {
                self.max_total_tokens.saturating_sub(truncate) as u32
165
            } else {
OlivierDehaene's avatar
OlivierDehaene committed
166
                return Err(ValidationError::UnsetMaxNewTokens);
167
            };
168
            let mut input_length = truncate.unwrap_or(self.max_input_length);
169

170
171
            // We don't have a tokenizer, therefore we have no idea how long is the query, let
            // them through and hope for the best.
172
            // Validate MaxNewTokens
173
            if (input_length as u32 + max_new_tokens) > self.max_total_tokens as u32 {
174
175
176
177
178
                input_length = input_length.saturating_sub(max_new_tokens as usize);
                // return Err(ValidationError::MaxNewTokens(
                //     self.max_total_tokens - self.max_input_length,
                //     max_new_tokens,
                // ));
179
180
            }

181
            Ok((inputs, input_length, max_new_tokens))
Olivier Dehaene's avatar
Olivier Dehaene committed
182
183
184
        }
    }

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
185
    /// Validate a payload and get the number of tokens in the input
186
    #[instrument(skip_all)]
Olivier Dehaene's avatar
Olivier Dehaene committed
187
188
189
    pub(crate) async fn validate(
        &self,
        request: GenerateRequest,
190
    ) -> Result<ValidGenerateRequest, ValidationError> {
191
192
193
194
        let GenerateParameters {
            best_of,
            temperature,
            repetition_penalty,
195
            frequency_penalty,
196
197
198
199
200
201
202
203
204
            top_k,
            top_p,
            typical_p,
            do_sample,
            max_new_tokens,
            stop: stop_sequences,
            truncate,
            seed,
            watermark,
205
            decoder_input_details,
Nicolas Patry's avatar
Nicolas Patry committed
206
            top_n_tokens,
drbh's avatar
drbh committed
207
            grammar,
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
            ..
        } = request.parameters;

        // sampling must be true when best_of > 1
        let best_of = best_of.unwrap_or(1);
        let sampling = do_sample
            || temperature.is_some()
            || top_k.is_some()
            || top_p.is_some()
            || typical_p.is_some();

        if best_of > 1 && !sampling {
            return Err(BestOfSampling);
        }

        let temperature = temperature.unwrap_or(1.0);
        if temperature <= 0.0 {
            return Err(ValidationError::Temperature);
        }

        let repetition_penalty = repetition_penalty.unwrap_or(1.0);
        if repetition_penalty <= 0.0 {
            return Err(ValidationError::RepetitionPenalty);
        }

233
234
235
236
237
        let frequency_penalty = frequency_penalty.unwrap_or(0.0);
        if !(-2.0..=2.0).contains(&frequency_penalty) {
            return Err(ValidationError::FrequencyPenalty);
        }

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
        // Different because the proto default value is not a valid value
        // for the user
        let top_p = top_p
            .map(|value| {
                if value <= 0.0 || value >= 1.0 {
                    return Err(ValidationError::TopP);
                }
                Ok(value)
            })
            .unwrap_or(Ok(1.0))?;

        let typical_p = typical_p
            .map(|value| {
                if value <= 0.0 || value >= 1.0 {
                    return Err(ValidationError::TypicalP);
                }
                Ok(value)
            })
            .unwrap_or(Ok(1.0))?;

        let top_k: u32 = top_k
            .map(|value| {
                if value <= 0 {
                    return Err(ValidationError::TopK);
                }
                Ok(value as u32)
            })
            .unwrap_or(Ok(0))?;

267
        if max_new_tokens == Some(0) {
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
            return Err(ValidationError::NegativeMaxNewTokens);
        }

        if stop_sequences.len() > self.max_stop_sequences {
            return Err(ValidationError::StopSequence(
                self.max_stop_sequences,
                stop_sequences.len(),
            ));
        }

        // If seed is None, assign a random one
        let seed = match seed {
            None => thread_rng().gen(),
            Some(seed) => {
                if best_of > 1 {
                    return Err(BestOfSeed);
                }
                seed
            }
        };

Nicolas Patry's avatar
Nicolas Patry committed
289
290
291
292
293
294
295
296
297
        let top_n_tokens = top_n_tokens
            .map(|value| {
                if value > self.max_top_n_tokens {
                    return Err(ValidationError::TopNTokens(self.max_top_n_tokens, value));
                }
                Ok(value)
            })
            .unwrap_or(Ok(0))?;

298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
        // Check if inputs is empty
        if request.inputs.is_empty() {
            return Err(EmptyInput);
        }

        // Check if truncate is strictly positive and less than max_input_length
        let truncate = truncate
            .map(|value| {
                if value == 0 || value > self.max_input_length {
                    return Err(ValidationError::Truncate(self.max_input_length, value));
                }
                Ok(Some(value))
            })
            .unwrap_or(Ok(None))?;

        // Validate inputs
314
        let (inputs, input_length, max_new_tokens) = self
315
316
317
            .validate_input(request.inputs, truncate, max_new_tokens)
            .await?;

drbh's avatar
drbh committed
318
319
320
321
322
323
324
325
326
327
328
329
330
331
        // TODO: we should build the FSM here and pass the compiled FSM instead of the grammar
        // NOTE: this is currently difficult because we need the tokenizer in Python to build
        // the FSM and we'd have to load a copy of the tokenizer into our Pyo3 instance which
        // may be slow and memory intensive. Best case is to have a Rust implementation of the FSM
        // compiler and use that to build the FSM here.

        // Validate grammar and unpack the grammar and type for the proto message
        let (grammar, grammar_type) = match grammar {
            Some(grammar) => {
                // Ensure that grammar is not set if it's not supported
                if self.disable_grammar_support {
                    return Err(ValidationError::Grammar);
                }
                match grammar {
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
                    GrammarType::Json(json) => {
                        let json = match json {
                            // if value is a string, we need to parse it again to make sure its
                            // a valid json
                            Value::String(s) => serde_json::from_str(&s)
                                .map_err(|e| ValidationError::InvalidGrammar(e.to_string())),
                            Value::Object(_) => Ok(json),
                            _ => Err(ValidationError::Grammar),
                        }?;

                        // Check if the json is a valid JSONSchema
                        JSONSchema::options()
                            .with_draft(Draft::Draft202012)
                            .compile(&json)
                            .map_err(|e| ValidationError::InvalidGrammar(e.to_string()))?;

                        (
                            // Serialize json to string
                            serde_json::to_string(&json)
                                .map_err(|e| ValidationError::InvalidGrammar(e.to_string()))?,
                            ProtoGrammarType::Json.into(),
                        )
                    }
drbh's avatar
drbh committed
355
356
357
358
359
360
                    GrammarType::Regex(regex) => (regex, ProtoGrammarType::Regex.into()),
                }
            }
            None => (String::new(), ProtoGrammarType::None.into()),
        };

361
362
363
        let parameters = NextTokenChooserParameters {
            temperature,
            repetition_penalty,
364
            frequency_penalty,
365
366
367
368
369
370
            top_k,
            top_p,
            typical_p,
            do_sample,
            seed,
            watermark,
drbh's avatar
drbh committed
371
372
            grammar,
            grammar_type,
373
374
375
376
377
378
379
380
381
382
383
        };
        let stopping_parameters = StoppingCriteriaParameters {
            max_new_tokens,
            stop_sequences,
            ignore_eos_token: false,
        };

        metrics::histogram!("tgi_request_max_new_tokens", max_new_tokens as f64);

        Ok(ValidGenerateRequest {
            inputs,
384
            decoder_input_details,
385
            input_length: input_length as u32,
386
387
388
            truncate: truncate.unwrap_or(self.max_input_length) as u32,
            parameters,
            stopping_parameters,
Nicolas Patry's avatar
Nicolas Patry committed
389
            top_n_tokens,
390
        })
Olivier Dehaene's avatar
Olivier Dehaene committed
391
    }
392
393
394
395
396
397
398
399
400
401
402
403
404
405

    /// Validate the best_of parameter
    #[instrument(skip_all)]
    pub(crate) fn validate_best_of(&self, best_of: usize) -> Result<usize, ValidationError> {
        if self.max_best_of == 1 && best_of != 1 {
            return Err(ValidationError::BestOfDisabled);
        }

        if best_of > self.max_best_of {
            return Err(ValidationError::BestOf(self.max_best_of, best_of));
        }

        Ok(best_of)
    }
Olivier Dehaene's avatar
Olivier Dehaene committed
406
407
}

OlivierDehaene's avatar
OlivierDehaene committed
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/// Round robin tokenization task
async fn round_robin_task(
    mut receiver: mpsc::UnboundedReceiver<TokenizerRequest>,
    senders: Vec<mpsc::UnboundedSender<TokenizerRequest>>,
) {
    loop {
        for sender in &senders {
            match receiver.recv().await {
                None => return,
                Some(request) => sender.send(request).unwrap(),
            };
        }
    }
}

423
/// Start tokenization workers
424
425
426
427
428
fn tokenizer_worker(
    tokenizer: Tokenizer,
    config: Option<Config>,
    mut receiver: mpsc::UnboundedReceiver<TokenizerRequest>,
) {
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
429
    // Loop over requests
OlivierDehaene's avatar
OlivierDehaene committed
430
    while let Some(((inputs, truncate), response_tx, parent_span)) = receiver.blocking_recv() {
431
432
        parent_span.in_scope(|| {
            response_tx
433
                .send(prepare_input(inputs, truncate, &tokenizer, &config))
434
435
                .unwrap_or(())
        })
436
437
    }
}
Olivier Dehaene's avatar
Olivier Dehaene committed
438

439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
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
487
488
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
fn format_from_mimetype(mimetype: &str) -> Option<ImageFormat> {
    match mimetype {
        "image/png" => Some(ImageFormat::Png),
        "image/jpeg" => Some(ImageFormat::Jpeg),
        "image/jpg" => Some(ImageFormat::Jpeg),
        "image/gif" => Some(ImageFormat::Gif),
        "image/webp" => Some(ImageFormat::WebP),
        "image/tiff" => Some(ImageFormat::Tiff),
        // "image/pnm"=>Some(ImageFormat::Pnm),
        // "image/tga"=>Some(ImageFormat::Tga),
        // "image/dds"=>Some(ImageFormat::Dds),
        // "image/bmp"=>Some(ImageFormat::Bmp),
        // "image/ico"=>Some(ImageFormat::Ico),
        // "image/x-exr"=>Some(ImageFormat::OpenExr),
        _ => None,
    }
}
fn format_to_mimetype(format: ImageFormat) -> String {
    match format {
        ImageFormat::Png => "image/png",
        ImageFormat::Jpeg => "image/jpeg",
        ImageFormat::Gif => "image/gif",
        ImageFormat::WebP => "image/webp",
        ImageFormat::Tiff => "image/tiff",
        _ => "application/octet-stream",
    }
    .to_string()
}

fn fetch_image(input: &str) -> Result<(String, usize, usize), ValidationError> {
    if input.starts_with("![](http://") || input.starts_with("![](https://") {
        let url = &input["![](".len()..input.len() - 1];
        let data = reqwest::blocking::get(url)?.bytes()?;

        let format = image::guess_format(&data)?;
        // TODO Remove this clone
        let img = ImageReader::with_format(Cursor::new(data.clone()), format).decode()?;
        let height: usize = img.height().try_into()?;
        let width: usize = img.width().try_into()?;
        let mimetype = format_to_mimetype(format);
        let encoded = STANDARD.encode(data);
        let data_uri = format!("![](data:{mimetype};base64,{encoded})");
        Ok((data_uri, height, width))
    } else if input.starts_with("![](data:") {
        // Remove ![](....)
        let content = &input["![](data:".len()..input.len() - 1];
        let tokens: Vec<_> = content.split(';').collect();
        if tokens.len() != 2 {
            return Err(ValidationError::InvalidImageContent(content.to_string()));
        }
        let mimetype = tokens[0];
        let content = tokens[1];

        if !content.starts_with("base64,") {
            return Err(ValidationError::InvalidImageContent(content.to_string()));
        }

        let data = STANDARD.decode(content["base64,".len()..].as_bytes())?;
        let img = if let Some(format) = format_from_mimetype(mimetype) {
            ImageReader::with_format(Cursor::new(data), format).decode()?
        } else {
            ImageReader::new(Cursor::new(data))
                .with_guessed_format()
                .map_err(|_io_error| ValidationError::InvalidImageContent(content.to_string()))?
                .decode()?
        };

        let height: usize = img.height().try_into()?;
        let width: usize = img.width().try_into()?;
        Ok((input.to_string(), height, width))
    } else {
        Err(ValidationError::InvalidImageContent(input.to_string()))
    }
}

514
515
/// Get input length and optionally truncate it
fn prepare_input(
516
    mut inputs: String,
517
    _truncate: Option<usize>,
518
    tokenizer: &Tokenizer,
519
    config: &Option<Config>,
520
) -> Result<(tokenizers::Encoding, String), ValidationError> {
521
522
523
524
525
526
527
528
    static RE: Lazy<Regex> = Lazy::new(|| Regex::new(r"!\[\]\([^\)]*\)").unwrap());
    let tokenizer_query = match config {
        Some(Config::LlavaNext(config)) => {
            let mut modified_inputs = String::with_capacity(inputs.len());
            let mut tokenizer_query = String::with_capacity(inputs.len());
            let mut start = 0;
            for chunk in RE.find_iter(&inputs) {
                let chunk_start = chunk.start();
drbh's avatar
drbh committed
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
                let chunk_end = chunk.end();
                if chunk_start != start {
                    modified_inputs.push_str(&inputs[start..chunk_start]);
                    tokenizer_query.push_str(&inputs[start..chunk_start]);
                }
                let (image_uri, height, width) = fetch_image(&inputs[chunk_start..chunk_end])?;
                let slots = config.get_number_of_features(height, width);
                tokenizer_query.push_str(&"<image>".repeat(slots));
                modified_inputs.push_str(&image_uri);
                start = chunk_end;
            }
            if start != inputs.len() - 1 {
                modified_inputs.push_str(&inputs[start..]);
                tokenizer_query.push_str(&inputs[start..]);
            }
            inputs = modified_inputs;
            tokenizer_query
        }
        Some(Config::Paligemma(config)) => {
            let mut modified_inputs = String::with_capacity(inputs.len());
            let mut tokenizer_query = String::with_capacity(inputs.len());
            let mut start = 0;
            for chunk in RE.find_iter(&inputs) {
                let chunk_start = chunk.start();
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
                let chunk_end = chunk.end();
                if chunk_start != start {
                    modified_inputs.push_str(&inputs[start..chunk_start]);
                    tokenizer_query.push_str(&inputs[start..chunk_start]);
                }
                let (image_uri, height, width) = fetch_image(&inputs[chunk_start..chunk_end])?;
                let slots = config.get_number_of_features(height, width);
                tokenizer_query.push_str(&"<image>".repeat(slots));
                modified_inputs.push_str(&image_uri);
                start = chunk_end;
            }
            if start != inputs.len() - 1 {
                modified_inputs.push_str(&inputs[start..]);
                tokenizer_query.push_str(&inputs[start..]);
            }
            inputs = modified_inputs;
            tokenizer_query
        }
Nicolas Patry's avatar
Nicolas Patry committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
        Some(Config::Idefics2(config)) => {
            let mut modified_inputs = String::with_capacity(inputs.len());
            let mut tokenizer_query = String::with_capacity(inputs.len());
            let mut start = 0;
            for chunk in RE.find_iter(&inputs) {
                let chunk_start = chunk.start();
                let chunk_end = chunk.end();
                if chunk_start != start {
                    modified_inputs.push_str(&inputs[start..chunk_start]);
                    tokenizer_query.push_str(&inputs[start..chunk_start]);
                }
                let (image_uri, height, width) = fetch_image(&inputs[chunk_start..chunk_end])?;
                let slots = config.get_number_of_features(height, width);
                tokenizer_query.push_str("<fake_token_around_image>");
                tokenizer_query.push_str(&"<image>".repeat(slots));
                tokenizer_query.push_str("<fake_token_around_image>");

                modified_inputs.push_str(&image_uri);
                start = chunk_end;
            }
            if start != inputs.len() - 1 {
                modified_inputs.push_str(&inputs[start..]);
                tokenizer_query.push_str(&inputs[start..]);
            }
            inputs = modified_inputs;
            tokenizer_query
        }
        Some(Config::Idefics) => {
            let mut modified_inputs = String::with_capacity(inputs.len());
            let mut tokenizer_query = String::with_capacity(inputs.len());
            let mut start = 0;
            for chunk in RE.find_iter(&inputs) {
                let chunk_start = chunk.start();
                let chunk_end = chunk.end();
                if chunk_start != start {
                    modified_inputs.push_str(&inputs[start..chunk_start]);
                    tokenizer_query.push_str(&inputs[start..chunk_start]);
                }
                let (image_uri, _height, _width) = fetch_image(&inputs[chunk_start..chunk_end])?;
                let slots = 1;
                tokenizer_query.push_str(&"<image>".repeat(slots));
                modified_inputs.push_str(&image_uri);
                start = chunk_end;
            }
            if start != inputs.len() - 1 {
                modified_inputs.push_str(&inputs[start..]);
                tokenizer_query.push_str(&inputs[start..]);
            }
            inputs = modified_inputs;
            tokenizer_query
        }
622
        _ => inputs.clone(),
623
    };
624

625
    // Get the number of tokens in the input
626
627
    let encoding = tokenizer
        .encode(tokenizer_query, true)
628
629
        .map_err(|err| ValidationError::Tokenizer(err.to_string()))?;

630
    Ok((encoding, inputs))
Olivier Dehaene's avatar
Olivier Dehaene committed
631
}
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
632

633
634
type TokenizerRequest = (
    (String, Option<usize>),
635
    oneshot::Sender<Result<(tokenizers::Encoding, String), ValidationError>>,
636
    Span,
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
637
638
);

639
#[derive(Debug, Clone)]
640
641
pub(crate) struct ValidGenerateRequest {
    pub inputs: String,
642
    pub input_length: u32,
643
    pub truncate: u32,
644
    pub decoder_input_details: bool,
645
646
    pub parameters: NextTokenChooserParameters,
    pub stopping_parameters: StoppingCriteriaParameters,
Nicolas Patry's avatar
Nicolas Patry committed
647
    pub top_n_tokens: u32,
648
649
}

Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
650
651
#[derive(Error, Debug)]
pub enum ValidationError {
652
653
654
655
656
657
658
659
660
661
    #[error("`best_of` must be > 0 and <= {0}. Given: {1}")]
    BestOf(usize, usize),
    #[error("`best_of` != 1 is not allowed for this endpoint")]
    BestOfDisabled,
    #[error("you must use sampling when `best_of` is > 1")]
    BestOfSampling,
    #[error("`seed` must not be set when `best_of` > 1")]
    BestOfSeed,
    #[error("`best_of` != 1 is not supported when streaming tokens")]
    BestOfStream,
Nicolas Patry's avatar
Nicolas Patry committed
662
663
664
665
    #[error("`top_n_tokens` must be >= 0 and <= {0}. Given: {1}")]
    TopNTokens(u32, u32),
    #[error("`top_n_tokens` != 0 is not allowed for this endpoint")]
    TopNTokensDisabled,
666
667
    #[error("`decoder_input_details` == true is not supported when streaming tokens")]
    PrefillDetailsStream,
668
    #[error("`temperature` must be strictly positive")]
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
669
    Temperature,
670
    #[error("`repetition_penalty` must be strictly positive")]
671
    RepetitionPenalty,
672
673
    #[error("`frequency_penalty` must be >= -2.0 and <= 2.0")]
    FrequencyPenalty,
674
    #[error("`top_p` must be > 0.0 and < 1.0")]
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
675
    TopP,
676
    #[error("`top_k` must be strictly positive")]
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
677
    TopK,
678
679
    #[error("`truncate` must be strictly positive and less than {0}. Given: {1}")]
    Truncate(usize, usize),
680
681
    #[error("`typical_p` must be > 0.0 and < 1.0")]
    TypicalP,
682
683
    #[error("one of `max_new_tokens` or `truncate` must be set if a fast tokenizer is not in use")]
    UnsetMaxNewTokens,
684
    #[error("`max_new_tokens` must be strictly positive")]
685
686
687
    NegativeMaxNewTokens,
    #[error("`max_new_tokens` must be <= {0}. Given: {1}")]
    MaxNewTokens(usize, u32),
688
    #[error("`inputs` tokens + `max_new_tokens` must be <= {0}. Given: {1} `inputs` tokens and {2} `max_new_tokens`")]
689
    MaxTotalTokens(usize, usize, u32),
690
    #[error("`inputs` must have less than {0} tokens. Given: {1}")]
691
    InputLength(usize, usize),
692
    #[error("`inputs` cannot be empty")]
693
    EmptyInput,
694
    #[error("`stop` supports up to {0} stop sequences. Given: {1}")]
695
    StopSequence(usize, usize),
696
697
    #[error("tokenizer error {0}")]
    Tokenizer(String),
drbh's avatar
drbh committed
698
699
    #[error("grammar is not supported")]
    Grammar,
700
701
    #[error("grammar is not valid: {0}")]
    InvalidGrammar(String),
702
703
704
705
706
707
708
709
710
711
    #[error("base64 encoding is invalid: {0}")]
    InvalidBase64(#[from] base64::DecodeError),
    #[error("invalid image: {0}")]
    InvalidImage(#[from] image::ImageError),
    #[error("invalid integer: {0}")]
    InvalidInt(#[from] core::num::TryFromIntError),
    #[error("invalid image content: {0}")]
    InvalidImageContent(String),
    #[error("Could not fetch image: {0}")]
    FailedFetchImage(#[from] reqwest::Error),
Olivier Dehaene's avatar
v0.1.0  
Olivier Dehaene committed
712
}
713
714

#[cfg(test)]
715
mod tests {
716
    use super::*;
717
718
    use crate::default_parameters;
    use crate::tests::get_tokenizer;
719
720

    #[tokio::test]
721
    async fn test_validation_max_new_tokens() {
722
723
724
        let tokenizer = None;
        let max_best_of = 2;
        let max_stop_sequence = 3;
Nicolas Patry's avatar
Nicolas Patry committed
725
726
727
        let max_top_n_tokens = 4;
        let max_input_length = 5;
        let max_total_tokens = 6;
728
        let workers = 1;
drbh's avatar
drbh committed
729
        let disable_grammar_support = true;
730
        let config = None;
731
732
733
        let validation = Validation::new(
            workers,
            tokenizer,
734
            config,
735
736
            max_best_of,
            max_stop_sequence,
Nicolas Patry's avatar
Nicolas Patry committed
737
            max_top_n_tokens,
738
739
            max_input_length,
            max_total_tokens,
drbh's avatar
drbh committed
740
            disable_grammar_support,
741
        );
742
743

        let max_new_tokens = 10;
744
        match validation
745
            .validate_input("Hello".to_string(), None, Some(max_new_tokens))
746
747
            .await
        {
748
749
750
            // Err(ValidationError::MaxNewTokens(1, 10)) => (),
            Ok((_s, 0, 10)) => (),
            r => panic!("Unexpected not max new tokens: {r:?}"),
751
752
753
754
        }
    }

    #[tokio::test]
755
    async fn test_validation_input_length() {
756
757
758
        let tokenizer = Some(get_tokenizer().await);
        let max_best_of = 2;
        let max_stop_sequence = 3;
Nicolas Patry's avatar
Nicolas Patry committed
759
760
761
        let max_top_n_tokens = 4;
        let max_input_length = 5;
        let max_total_tokens = 6;
drbh's avatar
drbh committed
762
        let disable_grammar_support = true;
763
        let workers = 1;
764
        let config = None;
765
766
767
        let validation = Validation::new(
            workers,
            tokenizer,
768
            config,
769
770
            max_best_of,
            max_stop_sequence,
Nicolas Patry's avatar
Nicolas Patry committed
771
            max_top_n_tokens,
772
773
            max_input_length,
            max_total_tokens,
drbh's avatar
drbh committed
774
            disable_grammar_support,
775
        );
776
777

        let max_new_tokens = 10;
778
        match validation
779
            .validate_input("Hello".to_string(), None, Some(max_new_tokens))
780
781
            .await
        {
Nicolas Patry's avatar
Nicolas Patry committed
782
            Err(ValidationError::MaxTotalTokens(6, 1, 10)) => (),
783
            _ => panic!("Unexpected not max new tokens"),
784
785
        }
    }
786
787

    #[tokio::test]
788
    async fn test_validation_best_of_sampling() {
789
790
791
        let tokenizer = Some(get_tokenizer().await);
        let max_best_of = 2;
        let max_stop_sequence = 3;
Nicolas Patry's avatar
Nicolas Patry committed
792
793
794
        let max_top_n_tokens = 4;
        let max_input_length = 5;
        let max_total_tokens = 6;
795
        let workers = 1;
drbh's avatar
drbh committed
796
        let disable_grammar_support = true;
797
        let config = None;
798
799
800
        let validation = Validation::new(
            workers,
            tokenizer,
801
            config,
802
803
            max_best_of,
            max_stop_sequence,
Nicolas Patry's avatar
Nicolas Patry committed
804
            max_top_n_tokens,
805
806
            max_input_length,
            max_total_tokens,
drbh's avatar
drbh committed
807
            disable_grammar_support,
808
809
810
811
812
813
814
815
816
817
818
819
        );
        match validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    best_of: Some(2),
                    do_sample: false,
                    ..default_parameters()
                },
            })
            .await
        {
820
            Err(ValidationError::BestOfSampling) => (),
821
            _ => panic!("Unexpected not best of sampling"),
822
823
824
825
        }
    }

    #[tokio::test]
826
    async fn test_validation_top_p() {
827
828
829
        let tokenizer = Some(get_tokenizer().await);
        let max_best_of = 2;
        let max_stop_sequence = 3;
Nicolas Patry's avatar
Nicolas Patry committed
830
831
        let max_top_n_tokens = 4;
        let max_input_length = 5;
832
        let max_total_tokens = 106;
833
        let workers = 1;
drbh's avatar
drbh committed
834
        let disable_grammar_support = true;
835
        let config = None;
836
837
838
        let validation = Validation::new(
            workers,
            tokenizer,
839
            config,
840
841
            max_best_of,
            max_stop_sequence,
Nicolas Patry's avatar
Nicolas Patry committed
842
            max_top_n_tokens,
843
844
            max_input_length,
            max_total_tokens,
drbh's avatar
drbh committed
845
            disable_grammar_support,
846
847
848
849
850
851
        );
        match validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_p: Some(1.0),
852
                    max_new_tokens: Some(5),
853
854
855
856
857
                    ..default_parameters()
                },
            })
            .await
        {
858
            Err(ValidationError::TopP) => (),
859
            _ => panic!("Unexpected top_p"),
860
861
        }

862
863
864
865
866
        match validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_p: Some(0.99),
867
                    max_new_tokens: Some(5),
868
869
870
871
872
                    ..default_parameters()
                },
            })
            .await
        {
873
            Ok(_) => (),
874
            _ => panic!("Unexpected top_p error"),
875
876
        }

877
878
879
880
881
        let valid_request = validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_p: None,
882
                    max_new_tokens: Some(5),
883
884
885
886
887
                    ..default_parameters()
                },
            })
            .await
            .unwrap();
888
889
890
        // top_p == 1.0 is invalid for users to ask for but it's the default resolved value.
        assert_eq!(valid_request.parameters.top_p, 1.0);
    }
Nicolas Patry's avatar
Nicolas Patry committed
891
892
893
894
895
896
897
898

    #[tokio::test]
    async fn test_validation_top_n_tokens() {
        let tokenizer = Some(get_tokenizer().await);
        let max_best_of = 2;
        let max_stop_sequences = 3;
        let max_top_n_tokens = 4;
        let max_input_length = 5;
899
        let max_total_tokens = 106;
Nicolas Patry's avatar
Nicolas Patry committed
900
        let workers = 1;
drbh's avatar
drbh committed
901
        let disable_grammar_support = true;
902
        let config = None;
Nicolas Patry's avatar
Nicolas Patry committed
903
904
905
        let validation = Validation::new(
            workers,
            tokenizer,
906
            config,
Nicolas Patry's avatar
Nicolas Patry committed
907
908
909
910
911
            max_best_of,
            max_stop_sequences,
            max_top_n_tokens,
            max_input_length,
            max_total_tokens,
drbh's avatar
drbh committed
912
            disable_grammar_support,
Nicolas Patry's avatar
Nicolas Patry committed
913
914
915
916
917
918
        );
        match validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_n_tokens: Some(5),
919
                    max_new_tokens: Some(5),
Nicolas Patry's avatar
Nicolas Patry committed
920
921
922
923
924
925
926
927
928
929
930
931
932
933
                    ..default_parameters()
                },
            })
            .await
        {
            Err(ValidationError::TopNTokens(4, 5)) => (),
            _ => panic!("Unexpected top_n_tokens"),
        }

        validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_n_tokens: Some(4),
934
                    max_new_tokens: Some(5),
Nicolas Patry's avatar
Nicolas Patry committed
935
936
937
938
939
940
941
942
943
944
945
                    ..default_parameters()
                },
            })
            .await
            .unwrap();

        validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_n_tokens: Some(0),
946
                    max_new_tokens: Some(5),
Nicolas Patry's avatar
Nicolas Patry committed
947
948
949
950
951
952
953
954
955
956
957
                    ..default_parameters()
                },
            })
            .await
            .unwrap();

        let valid_request = validation
            .validate(GenerateRequest {
                inputs: "Hello".to_string(),
                parameters: GenerateParameters {
                    top_n_tokens: None,
958
                    max_new_tokens: Some(5),
Nicolas Patry's avatar
Nicolas Patry committed
959
960
961
962
963
964
965
966
                    ..default_parameters()
                },
            })
            .await
            .unwrap();

        assert_eq!(valid_request.top_n_tokens, 0);
    }
967
}