Skip to main content

ModelSource

Enum ModelSource 

Source
pub enum ModelSource {
    LocalDir(PathBuf),
    HuggingFaceModelId(String),
}
Expand description

Configuration of where embedding model artifacts come from.

This is intentionally minimal and testable: it just answers “local dir or hub id?”.

Variants§

§

LocalDir(PathBuf)

Load from a local directory containing config.json, tokenizer.json, model.safetensors.

§

HuggingFaceModelId(String)

Load via HuggingFace Hub model id (downloaded/cached by hf-hub).

Implementations§

Source§

impl ModelSource

Source

pub fn from_iksh_env() -> Self

👎Deprecated since 0.2.0:

use from_embedd_env() or from_env_any()

Resolve from the legacy iksh environment variables.

Priority:

  1. IKSH_EMBED_MODEL_DIR (local, no network)
  2. IKSH_EMBED_MODEL (hub model id)
Source

pub fn from_embedd_env() -> Self

Resolve from EMBEDD_MODEL_DIR / EMBEDD_MODEL env vars.

Falls back to the default model when unset.

Source

pub fn from_env_any() -> Self

Prefer EMBEDD_* model env vars, else fall back to IKSH_*, else defaults.

Trait Implementations§

Source§

impl Clone for ModelSource

Source§

fn clone(&self) -> ModelSource

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 ModelSource

Source§

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

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

impl PartialEq for ModelSource

Source§

fn eq(&self, other: &ModelSource) -> 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 Eq for ModelSource

Source§

impl StructuralPartialEq for ModelSource

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.