refactor: Renamed Encoders to ModelToEncoder.

README.md

@@ -18,10 +18,9 @@ We will be happy to accept any PR.
 
 ### Usage
 ```csharp
-using Tiktoken.Encodings;
 using Tiktoken;
 
-var encoder = Encoders.ForModel("gpt-4o"); // or explicitly new Encoder(new O200KBase())
+var encoder = ModelToEncoder.For("gpt-4o"); // or explicitly using new Encoder(new O200KBase())
 var tokens = encoder.Encode("hello world"); // [15339, 1917]
 var text = encoder.Decode(tokens); // hello world
 var numberOfTokens = encoder.CountTokens(text); // 2

src/libs/Directory.Build.props

@@ -9,7 +9,7 @@
     </ItemGroup>
 
     <PropertyGroup Label="Nuget">
-        <Version>2.0.1</Version>
+        <Version>2.0.2</Version>
         <Description>The fastest tokenizer for GPT-3.5 and GPT-4 inspired by Tiktoken.</Description>
         <PackageTags>chatgpt;openai;tiktoken;tokens;gpt-4;gpt-3.5-turbo;cl100k_base;p50k_base</PackageTags>
         <GeneratePackageOnBuild Condition=" '$(Configuration)' == 'Release' ">true</GeneratePackageOnBuild>

src/libs/Tiktoken/ModelToEncoder.cs

@@ -0,0 +1,31 @@
+namespace Tiktoken;
+
+/// <summary>
+/// 
+/// </summary>
+public static class ModelToEncoder
+{
+    /// <summary>
+    /// Returns encoder by model name.
+    /// </summary>
+    /// <param name="modelName">gpt-3.5-turbo</param>
+    /// <returns></returns>
+    public static Encoder For(string modelName)
+    {
+        return new Encoder(ModelToEncoding.For(modelName));
+    }
+
+    /// <summary>
+    /// Returns encoder by model name or null.
+    /// </summary>
+    /// <param name="modelName">gpt-3.5-turbo</param>
+    /// <returns></returns>
+    public static Encoder? TryFor(string modelName)
+    {
+        var encoding = ModelToEncoding.TryFor(modelName);
+
+        return encoding == null
+            ? null
+            : new Encoder(encoding);
+    }
+}

src/libs/Tiktoken/Encoders.cs → src/libs/Tiktoken/ModelToEncoding.cs

@@ -5,33 +5,9 @@ namespace Tiktoken;
 /// <summary>
 /// 
 /// </summary>
-public static class Encoders
+public static class ModelToEncoding
 {
-    /// <summary>
-    /// Returns encoder by model name.
-    /// </summary>
-    /// <param name="modelName">gpt-3.5-turbo</param>
-    /// <returns></returns>
-    public static Encoder ForModel(string modelName)
-    {
-        return new Encoder(GetEncodingByModel(modelName));
-    }
-
-    /// <summary>
-    /// Returns encoder by model name or null.
-    /// </summary>
-    /// <param name="modelName">gpt-3.5-turbo</param>
-    /// <returns></returns>
-    public static Encoder? TryForModel(string modelName)
-    {
-        var encoding = TryGetEncodingByModel(modelName);
-
-        return encoding == null
-            ? null
-            : new Encoder(encoding);
-    }
-
-    private static Dictionary<string, Encoding> ModelToEncoding { get; } = new()
+    private static Dictionary<string, Encoding> Dictionary { get; } = new()
     {
         // chat
         { "gpt-4o", new O200KBase() },
@@ -51,9 +27,9 @@ public static Encoder ForModel(string modelName)
     /// <param name="modelName">gpt-4 gpt-3.5-turbo ...</param>
     /// <exception cref="ArgumentException"></exception>
     /// <returns></returns>
-    public static Encoding? TryGetEncodingByModel(string modelName)
+    public static Encoding? TryFor(string modelName)
     {
-        return ModelToEncoding
+        return Dictionary
             .FirstOrDefault(a => modelName.StartsWith(a.Key, StringComparison.Ordinal)).Value;
     }
 
@@ -63,9 +39,9 @@ public static Encoder ForModel(string modelName)
     /// <param name="modelName">gpt-4 gpt-3.5-turbo ...</param>
     /// <exception cref="ArgumentException"></exception>
     /// <returns></returns>
-    public static Encoding GetEncodingByModel(string modelName)
+    public static Encoding For(string modelName)
     {
-        return TryGetEncodingByModel(modelName) ??
+        return TryFor(modelName) ??
                throw new ArgumentException($"Model name {modelName} is not supported.");
     }
 }