1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 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 233 234 235 236 237 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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 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 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 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 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
use crate::pipelines::common::ModelType;
use crate::pipelines::translation::Language;
use std::fmt::Debug;
use tch::Device;
#[cfg(feature = "remote")]
use crate::{
pipelines::common::ModelResource,
pipelines::translation::{TranslationConfig, TranslationModel},
resources::ResourceProvider,
RustBertError,
};
#[derive(Clone, Copy, PartialEq)]
enum ModelSize {
Medium,
Large,
XLarge,
}
/// # Translation Model Builder
/// Allows the user to provide a variable set of inputs and identifies the best translation model that fulfills the constraints provided
/// by the user. Options that can provided by the user include:
/// - Target device (CPU/CUDA)
/// - Model size (medium, large or extra large)
/// - source languages to support (as an array of [`Language`])
/// - target languages to support (as an array of [`Language`])
/// - model type ([`ModelType`], supported models include `Marian`, `T5`, `MBart50` or `M2M100`)
///
/// The logic for selecting the most appropriate model is as follows:
/// - If not specified, the model will be executed on a CUDA device if available, otherwise on the CPU
/// - If the model type is specified (e.g. `Marian`), a model with this architecture will be created. The compatibility of the model
/// with the source and target languages will be verified, and the builder will error if the settings provided are not supported.
/// - If the model size is specified, a model of the corresponding size class (computational budget) will be created. The compatibility of the model
/// with the source and target languages will be verified, and the builder will error if the settings provided are not supported.
/// - If no source or target languages are provided, a multilingual M2M100 model will be returned
/// - If no model type is provided, an average sized-model (Marian) will be returned if a pretrained model exists that covers the requested source/target languages provided.
/// Otherwise a M2M100 multi-lingual model will be returned.
///
/// The options for the builder are provided with dedicated "builder function", the call to `create_model()` creates a model
/// from the builder.
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::{Language, TranslationModelBuilder};
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_source_languages(vec![Language::English])
/// .with_target_languages(vec![Language::Spanish, Language::French, Language::Italian])
/// .create_model()?;
///
/// let input_context_1 = "This is a sentence to be translated";
/// let input_context_2 = "The dog did not wake up.";
///
/// let output =
/// model.translate(&[input_context_1, input_context_2], None, Language::Spanish)?;
///
/// for sentence in output {
/// println!("{}", sentence);
/// }
/// Ok(())
/// }
/// ```
pub struct TranslationModelBuilder {
model_type: Option<ModelType>,
source_languages: Option<Vec<Language>>,
target_languages: Option<Vec<Language>>,
device: Option<Device>,
model_size: Option<ModelSize>,
}
impl Default for TranslationModelBuilder {
fn default() -> Self {
TranslationModelBuilder::new()
}
}
impl TranslationModelBuilder {
/// Build a new `TranslationModelBuilder`
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new().create_model();
/// Ok(())
/// }
/// ```
pub fn new() -> TranslationModelBuilder {
TranslationModelBuilder {
model_type: None,
source_languages: None,
target_languages: None,
device: None,
model_size: None,
}
}
/// Specify the device for the translation model
///
/// # Arguments
/// * `device` - [`tch::Device`] target device for the model.
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// use tch::Device;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_device(Device::Cuda(0))
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_device(&mut self, device: Device) -> &mut Self {
self.device = Some(device);
self
}
/// Specify the model type for the translation model
///
/// # Arguments
/// * `model_type` - [`ModelType`] type of translation model to load.
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::common::ModelType;
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_model_type(ModelType::M2M100)
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_model_type(&mut self, model_type: ModelType) -> &mut Self {
self.model_type = Some(model_type);
self
}
/// Use a medium-sized translation model (Marian-based)
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_medium_model()
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_medium_model(&mut self) -> &mut Self {
if let Some(model_type) = self.model_type {
if model_type != ModelType::Marian {
eprintln!(
"Model selection overwritten: was {:?}, replaced by {:?} (medium model selected)",
self.model_type.unwrap(),
ModelType::Marian
);
}
}
self.model_type = Some(ModelType::Marian);
self.model_size = Some(ModelSize::Medium);
self
}
/// Use a large translation model (M2M100, 418M parameters-based)
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_large_model()
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_large_model(&mut self) -> &mut Self {
if let Some(model_type) = self.model_type {
if model_type != ModelType::M2M100 {
eprintln!(
"Model selection overwritten: was {:?}, replaced by {:?} (large model selected)",
self.model_type.unwrap(),
ModelType::M2M100
);
}
}
self.model_type = Some(ModelType::M2M100);
self.model_size = Some(ModelSize::Large);
self
}
/// Use a very large translation model (M2M100, 1.2B parameters-based)
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_xlarge_model()
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_xlarge_model(&mut self) -> &mut Self {
if let Some(model_type) = self.model_type {
if model_type != ModelType::M2M100 {
eprintln!(
"Model selection overwritten: was {:?}, replaced by {:?} (xlarge model selected)",
self.model_type.unwrap(),
ModelType::M2M100
);
}
}
self.model_type = Some(ModelType::M2M100);
self.model_size = Some(ModelSize::XLarge);
self
}
/// Specify the source languages the model should support
///
/// # Arguments
/// * `source_languages` - Array-like of [`Language`] the model should be able to translate from
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::Language;
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_source_languages([Language::French, Language::Italian])
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_source_languages<S>(&mut self, source_languages: S) -> &mut Self
where
S: AsRef<[Language]> + Debug,
{
self.source_languages = Some(source_languages.as_ref().to_vec());
self
}
/// Specify the target languages the model should support
///
/// # Arguments
/// * `target_languages` - Array-like of [`Language`] the model should be able to translate to
///
/// # Returns
/// * `TranslationModelBuilder` Translation model builder
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::Language;
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_target_languages([
/// Language::Japanese,
/// Language::Korean,
/// Language::ChineseMandarin,
/// ])
/// .create_model();
/// Ok(())
/// }
/// ```
pub fn with_target_languages<T>(&mut self, target_languages: T) -> &mut Self
where
T: AsRef<[Language]> + Debug,
{
self.target_languages = Some(target_languages.as_ref().to_vec());
self
}
/// Creates the translation model based on the specifications provided
///
/// # Returns
/// * `TranslationModel` Generated translation model
///
/// # Example
///
/// ```no_run
/// use rust_bert::pipelines::translation::Language;
/// use rust_bert::pipelines::translation::TranslationModelBuilder;
/// fn main() -> anyhow::Result<()> {
/// let model = TranslationModelBuilder::new()
/// .with_target_languages([
/// Language::Japanese,
/// Language::Korean,
/// Language::ChineseMandarin,
/// ])
/// .create_model();
/// Ok(())
/// }
/// ```
#[cfg(feature = "remote")]
pub fn create_model(&self) -> Result<TranslationModel, RustBertError> {
let device = self.device.unwrap_or_else(Device::cuda_if_available);
let translation_resources = match (
&self.model_type,
&self.source_languages,
&self.target_languages,
) {
(Some(ModelType::M2M100), source_languages, target_languages) => {
match self.model_size {
Some(ModelSize::XLarge) => model_fetchers::get_m2m100_xlarge_resources(
source_languages.as_ref(),
target_languages.as_ref(),
)?,
_ => model_fetchers::get_m2m100_large_resources(
source_languages.as_ref(),
target_languages.as_ref(),
)?,
}
}
(Some(ModelType::MBart), source_languages, target_languages) => {
model_fetchers::get_mbart50_resources(
source_languages.as_ref(),
target_languages.as_ref(),
)?
}
(Some(ModelType::Marian), source_languages, target_languages) => {
model_fetchers::get_marian_model(
source_languages.as_ref(),
target_languages.as_ref(),
)?
}
(None, source_languages, target_languages) => model_fetchers::get_default_model(
&self.model_size,
source_languages.as_ref(),
target_languages.as_ref(),
)?,
(_, None, None) | (_, _, None) | (_, None, _) => {
return Err(RustBertError::InvalidConfigurationError(format!(
"Source and target languages must be specified for {:?}",
self.model_type.unwrap()
)));
}
(Some(model_type), _, _) => {
return Err(RustBertError::InvalidConfigurationError(format!(
"Automated translation model builder not implemented for {model_type:?}"
)));
}
};
let translation_config = TranslationConfig::new(
translation_resources.model_type,
ModelResource::Torch(Box::new(translation_resources.model_resource)),
translation_resources.config_resource,
translation_resources.vocab_resource,
Some(translation_resources.merges_resource),
translation_resources.source_languages,
translation_resources.target_languages,
device,
);
TranslationModel::new(translation_config)
}
}
#[cfg(feature = "remote")]
mod model_fetchers {
use super::*;
use crate::{
m2m_100::{
M2M100ConfigResources, M2M100MergesResources, M2M100ModelResources,
M2M100SourceLanguages, M2M100TargetLanguages, M2M100VocabResources,
},
marian::{
MarianConfigResources, MarianModelResources, MarianSourceLanguages, MarianSpmResources,
MarianTargetLanguages, MarianVocabResources,
},
mbart::{
MBartConfigResources, MBartModelResources, MBartSourceLanguages, MBartTargetLanguages,
MBartVocabResources,
},
resources::RemoteResource,
};
pub(super) struct TranslationResources<R>
where
R: ResourceProvider + Send + 'static,
{
pub(super) model_type: ModelType,
pub(super) model_resource: R,
pub(super) config_resource: R,
pub(super) vocab_resource: R,
pub(super) merges_resource: R,
pub(super) source_languages: Vec<Language>,
pub(super) target_languages: Vec<Language>,
}
macro_rules! get_marian_resources {
($name:ident) => {
(
(
MarianModelResources::$name,
MarianConfigResources::$name,
MarianVocabResources::$name,
MarianSpmResources::$name,
),
MarianSourceLanguages::$name.iter().cloned().collect(),
MarianTargetLanguages::$name.iter().cloned().collect(),
)
};
}
pub(super) fn get_default_model(
model_size: &Option<ModelSize>,
source_languages: Option<&Vec<Language>>,
target_languages: Option<&Vec<Language>>,
) -> Result<TranslationResources<RemoteResource>, RustBertError> {
Ok(match get_marian_model(source_languages, target_languages) {
Ok(marian_resources) => marian_resources,
Err(_) => match model_size {
Some(ModelSize::XLarge) => {
get_m2m100_xlarge_resources(source_languages, target_languages)?
}
_ => get_m2m100_large_resources(source_languages, target_languages)?,
},
})
}
pub(super) fn get_marian_model(
source_languages: Option<&Vec<Language>>,
target_languages: Option<&Vec<Language>>,
) -> Result<TranslationResources<RemoteResource>, RustBertError> {
let (resources, source_languages, target_languages) = if let (
Some(source_languages),
Some(target_languages),
) =
(source_languages, target_languages)
{
match (source_languages.as_slice(), target_languages.as_slice()) {
([Language::English], [Language::German]) => {
get_marian_resources!(ENGLISH2GERMAN)
}
([Language::English], [Language::Russian]) => {
get_marian_resources!(ENGLISH2RUSSIAN)
}
([Language::English], [Language::Dutch]) => {
get_marian_resources!(ENGLISH2DUTCH)
}
([Language::English], [Language::ChineseMandarin]) => {
get_marian_resources!(ENGLISH2CHINESE)
}
([Language::English], [Language::Swedish]) => {
get_marian_resources!(ENGLISH2SWEDISH)
}
([Language::English], [Language::Arabic]) => {
get_marian_resources!(ENGLISH2ARABIC)
}
([Language::English], [Language::Hindi]) => {
get_marian_resources!(ENGLISH2HINDI)
}
([Language::English], [Language::Hebrew]) => {
get_marian_resources!(ENGLISH2HEBREW)
}
([Language::German], [Language::English]) => {
get_marian_resources!(GERMAN2ENGLISH)
}
([Language::German], [Language::French]) => {
get_marian_resources!(GERMAN2FRENCH)
}
([Language::French], [Language::German]) => {
get_marian_resources!(FRENCH2GERMAN)
}
([Language::Russian], [Language::English]) => {
get_marian_resources!(RUSSIAN2ENGLISH)
}
([Language::Dutch], [Language::English]) => {
get_marian_resources!(DUTCH2ENGLISH)
}
([Language::ChineseMandarin], [Language::English]) => {
get_marian_resources!(CHINESE2ENGLISH)
}
([Language::Swedish], [Language::English]) => {
get_marian_resources!(SWEDISH2ENGLISH)
}
([Language::Arabic], [Language::English]) => {
get_marian_resources!(ARABIC2ENGLISH)
}
([Language::Hindi], [Language::English]) => {
get_marian_resources!(HINDI2ENGLISH)
}
([Language::Hebrew], [Language::English]) => {
get_marian_resources!(HEBREW2ENGLISH)
}
([Language::English], languages)
if languages
.iter()
.all(|lang| MarianTargetLanguages::ENGLISH2ROMANCE.contains(lang)) =>
{
get_marian_resources!(ENGLISH2ROMANCE)
}
(languages, [Language::English])
if languages
.iter()
.all(|lang| MarianSourceLanguages::ROMANCE2ENGLISH.contains(lang)) =>
{
get_marian_resources!(ROMANCE2ENGLISH)
}
(_, _) => {
return Err(RustBertError::InvalidConfigurationError(format!(
"No Pretrained Marian configuration found for {source_languages:?} to {target_languages:?} translation",
)));
}
}
} else {
return Err(RustBertError::InvalidConfigurationError(
"Source and target languages must be provided for Marian models".to_string(),
));
};
Ok(TranslationResources {
model_type: ModelType::Marian,
model_resource: RemoteResource::from_pretrained(resources.0),
config_resource: RemoteResource::from_pretrained(resources.1),
vocab_resource: RemoteResource::from_pretrained(resources.2),
merges_resource: RemoteResource::from_pretrained(resources.3),
source_languages,
target_languages,
})
}
pub(super) fn get_mbart50_resources(
source_languages: Option<&Vec<Language>>,
target_languages: Option<&Vec<Language>>,
) -> Result<TranslationResources<RemoteResource>, RustBertError> {
if let Some(source_languages) = source_languages {
if !source_languages
.iter()
.all(|lang| MBartSourceLanguages::MBART50_MANY_TO_MANY.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
source_languages,
MBartSourceLanguages::MBART50_MANY_TO_MANY
)));
}
}
if let Some(target_languages) = target_languages {
if !target_languages
.iter()
.all(|lang| MBartTargetLanguages::MBART50_MANY_TO_MANY.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
target_languages,
MBartTargetLanguages::MBART50_MANY_TO_MANY
)));
}
}
Ok(TranslationResources {
model_type: ModelType::MBart,
model_resource: RemoteResource::from_pretrained(
MBartModelResources::MBART50_MANY_TO_MANY,
),
config_resource: RemoteResource::from_pretrained(
MBartConfigResources::MBART50_MANY_TO_MANY,
),
vocab_resource: RemoteResource::from_pretrained(
MBartVocabResources::MBART50_MANY_TO_MANY,
),
merges_resource: RemoteResource::from_pretrained(
MBartVocabResources::MBART50_MANY_TO_MANY,
),
source_languages: MBartSourceLanguages::MBART50_MANY_TO_MANY.to_vec(),
target_languages: MBartTargetLanguages::MBART50_MANY_TO_MANY.to_vec(),
})
}
pub(super) fn get_m2m100_large_resources(
source_languages: Option<&Vec<Language>>,
target_languages: Option<&Vec<Language>>,
) -> Result<TranslationResources<RemoteResource>, RustBertError> {
if let Some(source_languages) = source_languages {
if !source_languages
.iter()
.all(|lang| M2M100SourceLanguages::M2M100_418M.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
source_languages,
M2M100SourceLanguages::M2M100_418M
)));
}
}
if let Some(target_languages) = target_languages {
if !target_languages
.iter()
.all(|lang| M2M100TargetLanguages::M2M100_418M.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
target_languages,
M2M100TargetLanguages::M2M100_418M
)));
}
}
Ok(TranslationResources {
model_type: ModelType::M2M100,
model_resource: RemoteResource::from_pretrained(M2M100ModelResources::M2M100_418M),
config_resource: RemoteResource::from_pretrained(M2M100ConfigResources::M2M100_418M),
vocab_resource: RemoteResource::from_pretrained(M2M100VocabResources::M2M100_418M),
merges_resource: RemoteResource::from_pretrained(M2M100MergesResources::M2M100_418M),
source_languages: M2M100SourceLanguages::M2M100_418M.to_vec(),
target_languages: M2M100TargetLanguages::M2M100_418M.to_vec(),
})
}
pub(super) fn get_m2m100_xlarge_resources(
source_languages: Option<&Vec<Language>>,
target_languages: Option<&Vec<Language>>,
) -> Result<TranslationResources<RemoteResource>, RustBertError> {
if let Some(source_languages) = source_languages {
if !source_languages
.iter()
.all(|lang| M2M100SourceLanguages::M2M100_1_2B.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
source_languages,
M2M100SourceLanguages::M2M100_1_2B
)));
}
}
if let Some(target_languages) = target_languages {
if !target_languages
.iter()
.all(|lang| M2M100TargetLanguages::M2M100_1_2B.contains(lang))
{
return Err(RustBertError::ValueError(format!(
"{:?} not in list of supported languages: {:?}",
target_languages,
M2M100TargetLanguages::M2M100_1_2B
)));
}
}
Ok(TranslationResources {
model_type: ModelType::M2M100,
model_resource: RemoteResource::from_pretrained(M2M100ModelResources::M2M100_1_2B),
config_resource: RemoteResource::from_pretrained(M2M100ConfigResources::M2M100_1_2B),
vocab_resource: RemoteResource::from_pretrained(M2M100VocabResources::M2M100_1_2B),
merges_resource: RemoteResource::from_pretrained(M2M100MergesResources::M2M100_1_2B),
source_languages: M2M100SourceLanguages::M2M100_1_2B.to_vec(),
target_languages: M2M100TargetLanguages::M2M100_1_2B.to_vec(),
})
}
}