Fixed some comments saying a method throws RunTime when it actually t…

…hrows a different exception
SciSharp · Jul 31, 2024 · 2a335d0 · 2a335d0
1 parent 955404f
commit 2a335d0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/LLama/LLamaContext.cs b/LLama/LLamaContext.cs
@@ -350,7 +350,6 @@ public void LoadState(string filename, LLamaSeqId sequence)
         /// Load the state from memory.
         /// </summary>
         /// <param name="state"></param>
-        /// <exception cref="RuntimeError"></exception>
         public void LoadState(State state)
         {
             unsafe
@@ -364,7 +363,6 @@ public void LoadState(State state)
         /// </summary>
         /// <param name="state"></param>
         /// <param name="sequence"></param>
-        /// <exception cref="RuntimeError"></exception>
         public void LoadState(SequenceState state, LLamaSeqId sequence)
         {
             unsafe

diff --git a/LLama/LLamaEmbedder.cs b/LLama/LLamaEmbedder.cs
@@ -44,7 +44,7 @@ public LLamaEmbedder(LLamaWeights weights, IContextParams @params, ILogger? logg
         /// <param name="text"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        /// <exception cref="RuntimeError"></exception>
+        /// <exception cref="LLamaDecodeError"></exception>
         public Task<float[]> GetEmbeddings(string text, CancellationToken cancellationToken = default)
         {
             return GetEmbeddings(text, true, cancellationToken);
@@ -57,7 +57,7 @@ public Task<float[]> GetEmbeddings(string text, CancellationToken cancellationTo
         /// <param name="addBos">Add bos to the text.</param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        /// <exception cref="RuntimeError"></exception>
+        /// <exception cref="LLamaDecodeError"></exception>
         public async Task<float[]> GetEmbeddings(string text, bool addBos, CancellationToken cancellationToken = default)
         {
             var tokens = Context.Tokenize(text, addBos);

diff --git a/LLama/Native/SafeLlamaModelHandle.cs b/LLama/Native/SafeLlamaModelHandle.cs
@@ -111,7 +111,8 @@ protected override bool ReleaseHandle()
         /// <param name="modelPath"></param>
         /// <param name="lparams"></param>
         /// <returns></returns>
-        /// <exception cref="RuntimeError"></exception>
+        /// <exception cref="InvalidOperationException"></exception>
+        /// <exception cref="LoadWeightsFailedException"></exception>
         public static SafeLlamaModelHandle LoadFromFile(string modelPath, LLamaModelParams lparams)
         {
             // Try to open the model file, this will check:
@@ -443,6 +444,7 @@ private static int llama_model_meta_val_str(SafeLlamaModelHandle model, string k
         /// <param name="modelBase">A path to a higher quality model to use as a base for the layers modified by the
         /// adapter. Can be NULL to use the current loaded model.</param>
         /// <param name="threads"></param>
+        /// <exception cref="InvalidOperationException"></exception>
         /// <exception cref="RuntimeError"></exception>
         public void ApplyLoraFromFile(string lora, float scale, string? modelBase = null, int? threads = null)
         {

diff --git a/LLama/Native/SafeLlavaModelHandle.cs b/LLama/Native/SafeLlavaModelHandle.cs
@@ -36,7 +36,7 @@ protected override bool ReleaseHandle()
         /// <param name="verbosity">Verbosity level</param>
         /// <returns>SafeHandle of the Clip Model</returns>
         /// <exception cref="InvalidOperationException"></exception>
-        /// <exception cref="RuntimeError"></exception>
+        /// <exception cref="LoadWeightsFailedException"></exception>
         public static SafeLlavaModelHandle LoadFromFile(string modelPath, int verbosity )
         {
             // Try to open the model file, this will check: