From c6179bf84631271096113f1750280e90a2049b3f Mon Sep 17 00:00:00 2001
From: Ziyang Hu <hu.ziyang@cantab.net>
Date: Tue, 27 Feb 2024 16:20:37 +0800
Subject: [PATCH] Add documentation to `load_session_file` and
 `save_session_file`

---
 llama-cpp-2/src/context/session.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/llama-cpp-2/src/context/session.rs b/llama-cpp-2/src/context/session.rs
index cfdd4608..4dca5c99 100644
--- a/llama-cpp-2/src/context/session.rs
+++ b/llama-cpp-2/src/context/session.rs
@@ -30,6 +30,12 @@ pub enum LoadSessionError {
 }
 
 impl LlamaContext<'_> {
+    /// Save the current session to a file.
+    ///
+    /// # Parameters
+    ///
+    /// * `path_session` - The file to save to.
+    /// * `tokens` - The tokens to associate the session with. This should be a prefix of a sequence of tokens that the context has processed, so that the relevant KV caches are already filled.
     pub fn save_session_file(&self, path_session: impl AsRef<Path>, tokens: &[LlamaToken]) -> Result<(), SaveSessionError> {
         let path = path_session.as_ref();
         let path = path
@@ -50,6 +56,12 @@ impl LlamaContext<'_> {
             Err(SaveSessionError::FailedToSave)
         }
     }
+    /// Load a session file into the current context.
+    ///
+    /// # Parameters
+    ///
+    /// * `path_session` - The file to load from. It must be a session file from a compatible context, otherwise the function will error.
+    /// * `max_tokens` - The maximum token length of the loaded session. If the session was saved with a longer length, the function will error.
     pub fn load_session_file(&mut self, path_session: impl AsRef<Path>, max_tokens: usize) -> Result<Vec<LlamaToken>, LoadSessionError> {
         let path = path_session.as_ref();
         let path = path