LLMHandle

Struct LLMHandle 

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

Handle to an LLM instance.

Implementations§

Source§

impl LLMHandle

Source

pub fn destroy(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Destroys the LLM instance and releases its resources.

Source

pub fn run( &self, rkllm_input: RKLLMInput, rkllm_infer_params: Option<RKLLMInferParam>, user_data: impl RkllmCallbackHandler + Send + Sync + 'static, ) -> Result<(), Box<dyn Error + Send + Sync>>

Runs an LLM inference task asynchronously.

§Parameters
  • rkllm_input: The input data for the LLM.
  • rkllm_infer_params: Optional parameters for the inference task.
  • user_data: The callback handler to process the results.
§Returns

This function does not return a value directly. Instead, it starts an asynchronous operation and processes results via the provided callback handler.

Source

pub fn load_prompt_cache( &self, cache_path: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

Loads a prompt cache from a file.

§Parameters
  • cache_path: The path to the prompt cache file.
Source

pub fn release_prompt_cache(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Release a prompt cache from a file.

Source

pub fn abort(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Aborts an ongoing LLM task

Source

pub fn is_running(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Checks if an LLM task is currently running.

Source

pub fn load_lora( &self, lora_cfg: &RKLLMLoraAdapter, ) -> Result<(), Box<dyn Error + Send + Sync>>

Loads a Lora adapter into the LLM.

Trait Implementations§

Source§

impl Clone for LLMHandle

Source§

fn clone(&self) -> LLMHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LLMHandle

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for LLMHandle

Source§

impl Send for LLMHandle

Source§

impl Sync for LLMHandle

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.