Skip to main content

Engine

Struct Engine 

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

A compiled decision engine. WASM is single-threaded, so the core engine is held directly (no Arc/lock); trainJson takes &mut self.

Implementations§

Source§

impl Engine

Source

pub fn new(options_json: &str) -> Result<Engine, JsValue>

optionsJson: {"embedder":"hash","dims":256}. The onnx arm ({"embedder":{"kind":"onnx",...}}) needs model bytes, so it is rejected here — use Engine.fromBytes instead.

Source

pub fn from_bytes( options_json: &str, model_bytes: &[u8], tokenizer_bytes: &[u8], ) -> Result<Engine, JsValue>

Construct an onnx-backed engine (tract) from in-memory model + tokenizer bytes. optionsJson carries the model manifest (a JSON string or an inline object). Requires the wasm-onnx build feature; otherwise returns the documented embedder error JSON as the thrown value. Throws on a hash mismatch or a model tract cannot load (fail closed, ADR-005).

Source

pub fn decide_json(&self, request_json: &str) -> String

Returns a DecisionResponse JSON, or the documented error JSON.

Source

pub fn train_json(&mut self, train_json: &str) -> String

Returns a TrainReport JSON, or the documented error JSON.

Source

pub fn stats_json(&self) -> String

{"embedderId","dims","examples","promotable"} from the bank summary.

Source

pub fn optimize_json(&self, campaign_json: &str) -> String

Run an optimize campaign (ADR-004). campaignJson is a CampaignSpec; returns a CampaignReport JSON or the documented error JSON.

Source

pub fn export_bank_json(&self) -> String

Full-fidelity bank JSON (the user’s own examples), or the error JSON.

Source

pub fn import_bank_json(&mut self, bank_json: &str) -> String

Replace the bank from JSON (re-embeds every stored text). Returns {"ok":true} or the documented error JSON.

Trait Implementations§

Source§

impl From<Engine> for JsValue

Source§

fn from(value: Engine) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for Engine

Source§

type Abi = WasmPtr<WasmRefCell<Engine>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for Engine

Source§

type Abi = WasmPtr<WasmRefCell<Engine>>

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for Engine

Source§

type Abi = WasmPtr<WasmRefCell<Engine>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<Engine>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for Engine

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for Engine

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for Engine

Source§

type Abi = WasmPtr<WasmRefCell<Engine>>

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<Engine>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for Engine

Source§

type Abi = WasmPtr<WasmRefCell<Engine>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<Engine>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for Engine

Source§

impl SupportsInstanceProperty for Engine

Source§

impl SupportsStaticProperty for Engine

Source§

impl TryFromJsValue for Engine

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for Engine

Source§

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

Source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Engine]>

Source§

impl VectorIntoWasmAbi for Engine

Source§

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

Source§

fn vector_into_abi(vector: Box<[Engine]>) -> Self::Abi

Source§

impl WasmDescribe for Engine

Source§

impl WasmDescribeVector for Engine

Auto Trait Implementations§

§

impl !Freeze for Engine

§

impl !RefUnwindSafe for Engine

§

impl !UnwindSafe for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl UnsafeUnpin for Engine

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, 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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more