pub struct StreamTextBuilder<'a, M: Model> { /* private fields */ }
Expand description

A builder for the ModelExt::stream_text method.

Implementations§

source§

impl<'a, M: Model> StreamTextBuilder<'a, M>

source

pub fn new( prompt: &'a str, self_: &'a M, future: fn(_: &'a M, _: &'a str, _: GenerationParameters) -> Pin<Box<dyn Future<Output = Result<M::TextStream>> + Send + 'a>> ) -> Self

Create a new builder to return from the ModelExt::stream_text method.

source

pub fn with_generation_parameters( self, parameters: GenerationParameters ) -> Self

Set the generation parameters to use when generating text. This will override any parameters set by other methods.

source

pub fn with_temperature(self, temperature: f32) -> Self

Set the temperature to use when generating text.

source

pub fn with_mu(self, mu: f32) -> Self

Set the mu to use when generating text.

source

pub fn with_tau(self, tau: f32) -> Self

Set the tau to use when generating text.

source

pub fn with_eta(self, eta: f32) -> Self

Set the eta to use when generating text.

source

pub fn with_repetition_penalty(self, repetition_penalty: f32) -> Self

Set the repetition penalty to use when generating text.

source

pub fn with_repetition_penalty_range( self, repetition_penalty_range: u32 ) -> Self

Set the repetition penalty range to use when generating text.

source

pub fn with_max_length(self, max_length: u32) -> Self

Set the maximum length to use when generating text.

source

pub fn with_stop_on(self, stop_on: impl Into<Option<String>>) -> Self

Set the string to stop on when generating text.

Trait Implementations§

source§

impl<'a, M: Model> IntoFuture for StreamTextBuilder<'a, M>

§

type Output = Result<<M as Model>::TextStream, Error>

The output that the future will produce on completion.
§

type IntoFuture = Pin<Box<dyn Future<Output = <StreamTextBuilder<'a, M> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?
source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<'a, M> RefUnwindSafe for StreamTextBuilder<'a, M>
where M: RefUnwindSafe,

§

impl<'a, M> Send for StreamTextBuilder<'a, M>

§

impl<'a, M> Sync for StreamTextBuilder<'a, M>

§

impl<'a, M> Unpin for StreamTextBuilder<'a, M>

§

impl<'a, M> UnwindSafe for StreamTextBuilder<'a, M>
where M: RefUnwindSafe,

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
§

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

§

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

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

fn try_into<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.
§

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

§

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
§

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