Skip to main content

ModelOptions

Struct ModelOptions 

Source
pub struct ModelOptions {
    pub seed: Option<i64>,
    pub temperature: Option<f32>,
    pub top_k: Option<i32>,
    pub top_p: Option<f32>,
    pub min_p: Option<f32>,
    pub num_ctx: Option<i32>,
    pub num_predict: Option<i32>,
    pub stop: Option<StopSetting>,
}
Expand description

Runtime options that control model behavior

These options can be used to customize embedding generation. All fields are optional and will use model defaults if not specified.

§Example

use ollama_oxide::ModelOptions;

let options = ModelOptions::default()
    .with_temperature(0.7)
    .with_num_ctx(4096);

Fields§

§seed: Option<i64>

Random seed for reproducible outputs

§temperature: Option<f32>

Controls randomness in generation (higher = more random)

§top_k: Option<i32>

Limits next token selection to the K most likely

§top_p: Option<f32>

Cumulative probability threshold for nucleus sampling

§min_p: Option<f32>

Minimum probability threshold for token selection

§num_ctx: Option<i32>

Context length size (number of tokens)

§num_predict: Option<i32>

Maximum number of tokens to generate

§stop: Option<StopSetting>

Stop sequences that will halt generation

Implementations§

Source§

impl ModelOptions

Source

pub fn new() -> Self

Create empty options (all defaults)

Source

pub fn with_seed(self, seed: i64) -> Self

Set the random seed

Source

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

Set the temperature

Source

pub fn with_top_k(self, top_k: i32) -> Self

Set the top_k value

Source

pub fn with_top_p(self, top_p: f32) -> Self

Set the top_p value

Source

pub fn with_min_p(self, min_p: f32) -> Self

Set the min_p value

Source

pub fn with_num_ctx(self, num_ctx: i32) -> Self

Set the context length

Source

pub fn with_num_predict(self, num_predict: i32) -> Self

Set the max tokens to generate

Source

pub fn with_stop(self, stop: impl Into<StopSetting>) -> Self

Set stop sequences

Source

pub fn is_empty(&self) -> bool

Check if any options are set

Trait Implementations§

Source§

impl Clone for ModelOptions

Source§

fn clone(&self) -> ModelOptions

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 ModelOptions

Source§

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

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

impl Default for ModelOptions

Source§

fn default() -> ModelOptions

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ModelOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ModelOptions

Source§

fn eq(&self, other: &ModelOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ModelOptions

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ModelOptions

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,