ct2rs 0.9.18

Rust bindings for OpenNMT/CTranslate2
Documentation 
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

// sys.rs
//
// Copyright (c) 2023-2025 Junpei Kawamoto
//
// This software is released under the MIT License.
//
// http://opensource.org/licenses/mit-license.php

//! This module provides raw bindings for CTranslate2.
//!
//! This module provides Rust bindings for
//! [ctranslate2::Translator](https://opennmt.net/CTranslate2/python/ctranslate2.Translator.html),
//! [ctranslate2::Generator](https://opennmt.net/CTranslate2/python/ctranslate2.Generator.html),
//! and
//! [ctranslate2::Whisper](https://opennmt.net/CTranslate2/python/ctranslate2.models.Whisper.html)
//! along with
//! related structures.
//!
//! # Translator
//! The main structure is the [`Translator`], which serves as
//! the interface to the translation functionalities of the `ctranslate2` library.
//!
//! In addition to the `Translator`, this module also offers various supportive structures such
//! as [`TranslationOptions`] and [`TranslationResult`].
//!
//! # Generator
//! The [`Generator`] structure is the primary interface, offering the capability
//! to generate text based on a trained model. It is designed for tasks such as text generation,
//! autocompletion, and other similar language generation tasks.
//!
//! Alongside the `Generator`, this module also includes structures that are critical for
//! controlling and understanding the generation process:
//!
//! - [`GenerationOptions`]: A structure containing configuration options for the generation
//!   process,
//!
//! - [`GenerationResult`]: A structure that holds the results of the generation process.
//!
//! # Whisper
//! The main structure is the [`Whisper`].
//!
//! In addition to the `Whisper`, this module also offers various supportive structures such
//! as [`WhisperOptions`], [`DetectionResult`], and [`WhisperGenerationResult`].
//!
//! For more detailed information on each structure and its usage, please refer to their respective
//! documentation within this module.

pub use config::*;
pub use generator::*;
pub use model_memory_reader::*;
pub use scoring::*;
pub use storage_view::*;
pub use translator::*;
pub use types::*;
pub use whisper::*;

mod config;
mod generator;
mod model_memory_reader;
mod scoring;
mod storage_view;
mod translator;
mod types;
mod whisper;