Merge pull request #304 from martindevans/obsolete_attribute_eval

Added Obsolete markings to all `Eval` overloads
SciSharp · Nov 17, 2023 · c517cc1 · c517cc1
2 parents 18b3a55 + 16ab33b
commit c517cc1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/LLama/LLamaContext.cs b/LLama/LLamaContext.cs
@@ -340,6 +340,7 @@ public LLamaTokenDataArray ApplyPenalty(IEnumerable<llama_token> lastTokens, Dic
  /// <param name="pastTokensCount"></param>
  /// <returns>The updated `pastTokensCount`.</returns>
  /// <exception cref="RuntimeError"></exception>
+ [Obsolete("use llama_decode() instead")]
  public int Eval(llama_token[] tokens, int pastTokensCount)
  {
  return Eval(tokens.AsSpan(), pastTokensCount);
@@ -352,6 +353,7 @@ public int Eval(llama_token[] tokens, int pastTokensCount)
  /// <param name="pastTokensCount"></param>
  /// <returns>The updated `pastTokensCount`.</returns>
  /// <exception cref="RuntimeError"></exception>
+ [Obsolete("use llama_decode() instead")]
  public int Eval(List<llama_token> tokens, int pastTokensCount)
  {
 #if NET5_0_OR_GREATER
@@ -382,6 +384,7 @@ public int Eval(List<llama_token> tokens, int pastTokensCount)
  /// <param name="pastTokensCount"></param>
  /// <returns>The updated `pastTokensCount`.</returns>
  /// <exception cref="RuntimeError"></exception>
+ [Obsolete("use llama_decode() instead")]
  public int Eval(ReadOnlyMemory<llama_token> tokens, int pastTokensCount)
  {
  return Eval(tokens.Span, pastTokensCount);
@@ -394,6 +397,7 @@ public int Eval(ReadOnlyMemory<llama_token> tokens, int pastTokensCount)
  /// <param name="pastTokensCount"></param>
  /// <returns>The updated `pastTokensCount`.</returns>
  /// <exception cref="RuntimeError"></exception>
+ [Obsolete("use llama_decode() instead")]
  public int Eval(ReadOnlySpan<llama_token> tokens, int pastTokensCount)
  {
  var total = tokens.Length;
@@ -415,7 +419,7 @@ public int Eval(ReadOnlySpan<llama_token> tokens, int pastTokensCount)
  }
  return pastTokensCount;
  }
-#endregion
+ #endregion
 
  /// <inheritdoc />
  public void Dispose()

diff --git a/LLama/Native/SafeLLamaContextHandle.cs b/LLama/Native/SafeLLamaContextHandle.cs
@@ -193,6 +193,7 @@ public int TokenToSpan(int token, Span<byte> dest)
  /// <param name="tokens">The provided batch of new tokens to process</param>
  /// <param name="n_past">the number of tokens to use from previous eval calls</param>
  /// <returns>Returns true on success</returns>
+ [Obsolete("use llama_decode() instead")]
  public bool Eval(ReadOnlySpan<int> tokens, int n_past)
  {
  unsafe