use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::Arc;
use ndarray::{Array, Array2, Array3, IxDyn};
use ort::environment::Environment;
use ort::session::{Input, Output};
use ort::tensor::{FromArray, InputTensor};
use ort::{GraphOptimizationLevel, SessionBuilder};
use crate::common::Device;
use crate::common::{apply_device, match_to_inputs};
use crate::error::{Error, Result};
use crate::{try_extract_to_f32, ORTSession};
pub struct ConditionalGenerationModel<'a> {
model_session: ORTSession<'a>,
token_type_support: bool,
}
impl<'a> ConditionalGenerationModel<'a> {
pub fn new_from_memory(
env: Arc<Environment>,
model_bytes: &'a [u8],
device: Device,
optimization_level: GraphOptimizationLevel,
) -> Result<Self> {
let mut session_builder = SessionBuilder::new(&env)?;
session_builder = apply_device(session_builder, device)?;
let session = session_builder
.with_optimization_level(optimization_level)?
.with_model_from_memory(model_bytes)?;
let token_type_support = Self::validate_signature(&session.inputs, &session.outputs)?;
Ok(Self {
model_session: ORTSession::InMemory(session),
token_type_support,
})
}
pub fn new_from_file(
env: Arc<Environment>,
model_path: PathBuf,
device: Device,
optimization_level: GraphOptimizationLevel,
) -> Result<Self> {
let mut session_builder = SessionBuilder::new(&env)?;
session_builder = apply_device(session_builder, device)?;
let session = session_builder
.with_optimization_level(optimization_level)?
.with_model_from_file(&model_path)?;
let token_type_support = Self::validate_signature(&session.inputs, &session.outputs)?;
Ok(Self {
model_session: ORTSession::Owned(session),
token_type_support,
})
}
fn validate_signature(inputs: &Vec<Input>, outputs: &Vec<Output>) -> Result<bool> {
let token_type_support = inputs.iter().any(|input| input.name == "token_type_ids");
let past_values: Vec<String> = inputs
.iter()
.filter(|input| input.name.contains("past_key_values"))
.map(|input| input.name.to_string())
.collect();
if past_values.len() != 0 {
return Err(Error::OnnxIncorrectInputs {
message: "The model needs support past key values. Use ConditionalGenerationModelWithPKVs instead".to_string(),
expected: vec!["input_ids".to_string(), "attention_mask".to_string()],
actual: past_values,
});
}
if inputs.iter().all(|inp| inp.name != "input_ids")
|| inputs.iter().all(|inp| inp.name != "attention_mask")
{
return Err(Error::OnnxIncorrectInputs {
message: "The model does not have the required inputs.".to_string(),
actual: inputs.iter().map(|inp| inp.name.to_string()).collect(),
expected: vec!["input_ids".to_string(), "attention_mask".to_string()],
});
}
if outputs.iter().all(|output| output.name != "logits") {
return Err(Error::OnnxIncorrectOutputs {
message: "The model does not have a logits output.".to_string(),
actual: outputs.iter().map(|inp| inp.name.to_string()).collect(),
expected: vec!["logits".to_string()],
});
}
Ok(token_type_support)
}
pub fn forward(
&self,
input_ids: Array2<u32>,
attention_mask: Option<Array2<u32>>,
token_type_ids: Option<Array2<u32>>,
) -> Result<Array3<f32>> {
let input_map = self.prepare_input_map(input_ids, attention_mask, token_type_ids)?;
let model = match &self.model_session {
ORTSession::InMemory(session) => session,
ORTSession::Owned(session) => session,
};
let input_tensor = match_to_inputs(&model.inputs, input_map)?;
let output_names: Vec<String> = model
.outputs
.iter()
.map(|output| output.name.to_string())
.collect();
let output_vec = model.run(input_tensor)?;
let mut output_map = HashMap::new();
for (name, tensor) in output_names.iter().zip(output_vec) {
let extracted = try_extract_to_f32(tensor)?;
let view = extracted.view();
let owned = view.to_owned();
let dimensionality = owned.into_dimensionality::<IxDyn>()?;
output_map.insert(name.to_string(), dimensionality);
}
let output_logit = output_map.remove("logits").unwrap();
Ok(output_logit.into_dimensionality()?)
}
fn prepare_input_map(
&self,
input_ids: Array2<u32>,
attention_mask: Option<Array2<u32>>,
token_type_ids: Option<Array2<u32>>,
) -> Result<HashMap<String, InputTensor>> {
let attention_mask = if attention_mask.is_none() {
Array::ones((input_ids.shape()[0], input_ids.shape()[1]))
} else {
attention_mask.unwrap()
};
let token_type_ids = if self.token_type_support {
Some(if token_type_ids.is_none() {
Array::zeros((input_ids.shape()[0], input_ids.shape()[1]))
} else {
token_type_ids.unwrap()
})
} else {
None
};
let mut input_map = HashMap::<String, InputTensor>::new();
if let Some(token_types_array) = token_type_ids {
input_map.insert(
"token_type_ids".to_string(),
InputTensor::from_array(token_types_array.into_dimensionality()?),
);
}
input_map.insert(
"input_ids".to_string(),
InputTensor::from_array(input_ids.into_dimensionality()?),
);
input_map.insert(
"attention_mask".to_string(),
InputTensor::from_array(attention_mask.into_dimensionality()?),
);
Ok(input_map)
}
pub fn get_token_type_support(&self) -> bool {
self.token_type_support
}
}
#[cfg(test)]
mod tests {
use crate::hf_hub::hf_hub_download;
use super::*;
#[test]
fn test_model() {
let env = Environment::builder().build().unwrap();
let model = ConditionalGenerationModel::new_from_file(
env.into_arc(),
hf_hub_download("optimum/gpt2", "decoder_model.onnx", None, None).unwrap(),
Device::CPU,
GraphOptimizationLevel::Level3,
)
.unwrap();
let input = vec![
50256, 50256, 50256, 50256, 50256, 50256, 50256, 50256, 50256, 50256,
];
let ndarray_input = Array2::<u32>::from_shape_vec((1, 10), input.clone()).unwrap();
let output = model.forward(ndarray_input, None, None).unwrap();
println!("{:?}", output);
assert_eq!(output.shape(), &[1, 10, 50257]);
}
}