added docs

Author: MarcusDunn

llama-cpp-2/src/context/session.rs

@@ -5,26 +5,34 @@ use crate::token::LlamaToken;
 use std::ffi::{CString, NulError};
 use std::path::{Path, PathBuf};
 
+/// Failed to save a Session file
 #[derive(Debug, Eq, PartialEq, thiserror::Error)]
 pub enum SaveSessionError {
+    /// llama.cpp failed to save the session file
     #[error("Failed to save session file")]
     FailedToSave,
 
+    /// null byte in string
     #[error("null byte in string {0}")]
     NullError(#[from] NulError),
 
+    /// failed to convert path to str
     #[error("failed to convert path {0} to str")]
     PathToStrError(PathBuf),
 }
 
+/// Failed to load a Session file
 #[derive(Debug, Eq, PartialEq, thiserror::Error)]
 pub enum LoadSessionError {
+    /// llama.cpp failed to load the session file
     #[error("Failed to load session file")]
     FailedToLoad,
 
+    /// null byte in string
     #[error("null byte in string {0}")]
     NullError(#[from] NulError),
 
+    /// failed to convert path to str
     #[error("failed to convert path {0} to str")]
     PathToStrError(PathBuf),
 }

simple/src/main.rs

@@ -58,7 +58,7 @@ enum Model {
 
 impl Model {
     /// Convert the model to a path - may download from huggingface
-    fn to_path(self) -> Result<PathBuf> {
+    fn as_path(self) -> Result<PathBuf> {
         match self {
             Model::Local { path } => Ok(path),
             Model::HuggingFace { model, repo } => ApiBuilder::new()
@@ -97,7 +97,7 @@ fn main() -> Result<()> {
     };
 
     let model_path = model
-        .to_path()
+        .as_path()
         .with_context(|| "failed to get model from args")?;
 
     let model = LlamaModel::load_from_file(&backend, model_path, &model_params)
@@ -116,7 +116,7 @@ fn main() -> Result<()> {
 
     let tokens_list = model
         .str_to_token(&prompt, AddBos::Always)
-        .with_context(|| format!("failed to tokenize {}", prompt))?;
+        .with_context(|| format!("failed to tokenize {prompt}"))?;
 
     let n_cxt = ctx.n_ctx() as i32;
     let n_kv_req = tokens_list.len() as i32 + (n_len - tokens_list.len() as i32);