Struct Bloom

pub struct Bloom { /* private fields */ }

The BLOOM model. Ref: Introducing BLOOM

Safety

This implements Send and Sync as it is immutable after construction.

Implementations

impl Bloom

pub fn load( path: &Path, params: ModelParameters, load_progress_callback: impl FnMut(LoadProgress), ) -> Result<Bloom, LoadError>

Load a BLOOM model from the path and configure it per the params. The status of the loading process will be reported through load_progress_callback. This is a helper function on top of llm_base::load.

Trait Implementations

impl KnownModel for Bloom

fn vocabulary(&self) -> &Vocabulary

Returns the vocabulary used by this model.

type Hyperparameters = Hyperparameters

Hyperparameters for the model

fn new<E: Error>( hyperparameters: Self::Hyperparameters, params: ModelParameters, vocabulary: Vocabulary, tensor_loader: impl TensorLoader<E>, ) -> Result<Self, E>

Creates a new model from the provided ModelParameters hyperparameters. This function is called by the load function.

fn start_session(&self, config: InferenceSessionConfig) -> InferenceSession

Starts a new InferenceSession for this model.

fn evaluate( &self, session: &mut InferenceSession, params: &InferenceParameters, input_tokens: &[TokenId], output_request: &mut OutputRequest, )

This function is called by the provided InferenceSession; it will use this model and the InferenceParameters to generate output by evaluating the input_tokens. The OutputRequest is used to specify additional data to fetch from the model.

fn n_context_tokens(&self) -> usize

Get the context size (configured with ModelParameters::n_context_tokens) used by this model.

fn bot_token_id(&self) -> Option<TokenId>

Get the beginning of text/beginning of string token ID, if available. This value is defined by model implementers.

fn eot_token_id(&self) -> TokenId

Get the end of text/end of string token ID. This value is defined by model implementers.

fn inference_parameters(&self) -> &InferenceParameters

Get the default InferenceParameters for this model (used by InferenceSession::infer). This value is configured through ModelParameters::inference_parameters.

impl Send for Bloom

impl Sync for Bloom