Struct Model

pub struct Model<Input = PredictInput, Output = PredictOutput>
where
    Input: Into<PredictInput>,
    Output: From<PredictOutput> + Into<PredictOutput>,
{ /* private fields */ }

Use this struct to load a model, make predictions, and log events to the app.

Implementations

impl<Input, Output> Model<Input, Output>

where Input: Into<PredictInput>, Output: From<PredictOutput> + Into<PredictOutput>,

Use this struct to load a model, make predictions, and log events to the app.

pub fn from_path( path: impl AsRef<Path>, options: Option<LoadModelOptions>, ) -> Result<Model<Input, Output>>

Load a model from the .tangram file at path.

pub fn from_bytes( bytes: &[u8], options: Option<LoadModelOptions>, ) -> Result<Model<Input, Output>>

Load a model from a byte slice. You should use this only if you already have a .tangram loaded into memory. Otherwise, use Model::from_path, which is faster because it memory maps the file.

pub fn id(&self) -> &str

Retrieve the model’s id.

pub fn predict_one( &self, input: Input, options: Option<PredictOptions>, ) -> Output

Make a prediction with a single input.

pub fn predict( &self, input: Vec<Input>, options: Option<PredictOptions>, ) -> Vec<Output>

Make a prediction with multiple inputs.

pub fn log_prediction( &mut self, args: LogPredictionArgs<Input, Output>, ) -> Result<()>

Send a prediction event to the app. If you want to batch events, you can use Model::enqueue_log_true_value instead.

pub fn log_true_value(&mut self, args: LogTrueValueArgs) -> Result<()>

Send a true value event to the app. If you want to batch events, you can use Model::enqueue_log_true_value instead.

pub fn enqueue_log_prediction(&mut self, args: LogPredictionArgs<Input, Output>)

Add a prediction event to the queue. Remember to call Model::flush_log_queue at a later point to send the event to the app.

pub fn enqueue_log_true_value(&mut self, args: LogTrueValueArgs)

Add a true value event to the queue. Remember to call Model::flush_log_queue at a later point to send the event to the app.

pub fn flush_log_queue(&mut self) -> Result<()>

Send all events in the queue to the app.