Document Sampler

nkoppel · nkoppel · commit 261f39754591 · 2024-03-01T16:44:23.000-06:00
diff --git a/crates/llama_cpp/src/lib.rs b/crates/llama_cpp/src/lib.rs
@@ -112,9 +112,13 @@ pub struct Token(pub i32);
 #[error("an internal assertion failed in llama.cpp; check `tracing` output.")]
 pub struct LlamaInternalError;
 
-/// This needs to be documented!
+/// Something which selects a [`Token`] from the distribution output by a
+/// [`LlamaModel`].
 pub trait Sampler {
-    /// This needs to be documented!
+    /// Given a [`llama_context`], the tokens in context (to allow for
+    /// repetition penalities), and a [`llama_token_data_array`] (which contains
+    /// the distribution over the next token as output by the model), selects a
+    /// token.
     fn sample(
         &mut self,
         context: *mut llama_context,
