Struct TextGenerationModel

Source
pub struct TextGenerationModel { /* private fields */ }
Expand description

§TextGenerationModel to generate texts from a prompt

Implementations§

Source§

impl TextGenerationModel

Source

pub fn new( generation_config: TextGenerationConfig, ) -> Result<TextGenerationModel, RustBertError>

Build a new TextGenerationModel

§Arguments
  • generation_config - GenerateConfig object containing the resource references (model, vocabulary, configuration), generation options and device placement (CPU/GPU)
§Example
use rust_bert::pipelines::common::ModelType;
use rust_bert::pipelines::text_generation::TextGenerationModel;

let generation_model = TextGenerationModel::new(Default::default())?;
Source

pub fn new_with_tokenizer( generation_config: TextGenerationConfig, tokenizer: TokenizerOption, ) -> Result<TextGenerationModel, RustBertError>

Build a new TextGenerationModel with a given tokenizer

§Arguments
  • generation_config - GenerateConfig object containing the resource references (model, vocabulary, configuration), generation options and device placement (CPU/GPU)
  • tokenizer - TokenizerOption tokenizer to use for text generation
§Example
use rust_bert::pipelines::common::{ModelType, TokenizerOption};
use rust_bert::pipelines::text_generation::TextGenerationModel;

let tokenizer = TokenizerOption::from_file(
    ModelType::GPT2,
    "path/to/vocab.json",
    Some("path/to/merges.txt"),
    false,
    None,
    None,
)?;
let generation_model = TextGenerationModel::new_with_tokenizer(Default::default(), tokenizer)?;
Source

pub fn get_tokenizer(&self) -> &TokenizerOption

Source

pub fn get_tokenizer_mut(&mut self) -> &mut TokenizerOption

Source

pub fn half(&mut self) -> Result<(), RustBertError>

Source

pub fn float(&mut self) -> Result<(), RustBertError>

Source

pub fn set_device(&mut self, device: Device) -> Result<(), RustBertError>

Source

pub fn generate<'a, S>( &self, texts: &[S], prefix: impl Into<Option<&'a str>>, ) -> Result<Vec<String>, RustBertError>
where S: AsRef<str> + Send + Sync,

Generate texts from provided prompts

§Arguments
  • input - &[&str] Array of texts to summarize.
  • prefix - impl Into<Option<&'a str>>: Optional string to pass as a prefix for generation. Will be excluded from generated sequences.
§Returns
  • Vec<String> Generated texts
§Example
use rust_bert::pipelines::common::ModelType;
use rust_bert::pipelines::text_generation::TextGenerationModel;

let model = TextGenerationModel::new(Default::default())?;

let input = ["The dog", "The cat was"];
let prefix = None;

let output = model.generate(&input, prefix);

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T