Tokenizers.HuggingFace 1.0.1-experimental.1

This is a prerelease version of Tokenizers.HuggingFace.
dotnet add package Tokenizers.HuggingFace --version 1.0.1-experimental.1
                    
NuGet\Install-Package Tokenizers.HuggingFace -Version 1.0.1-experimental.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Tokenizers.HuggingFace" Version="1.0.1-experimental.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Tokenizers.HuggingFace" Version="1.0.1-experimental.1" />
                    
Directory.Packages.props
<PackageReference Include="Tokenizers.HuggingFace" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Tokenizers.HuggingFace --version 1.0.1-experimental.1
                    
#r "nuget: Tokenizers.HuggingFace, 1.0.1-experimental.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Tokenizers.HuggingFace&version=1.0.1-experimental.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Tokenizers.HuggingFace&version=1.0.1-experimental.1&prerelease
                    
Install as a Cake Tool

Tokenizers.HuggingFace

.NET bindings for huggingface/tokenizers using protobufs for comunication and C-ABI.

How to install

dotnet add package Tokenizers.HuggingFace

Supported targets

  • win-x64
  • linux-x64
  • osx-x64
  • osx-arm64
  • win-arm64
  • linux-arm64

Usage

Casses:

  • Normalization
  • PreTokenization
  • Tokenizer (Encode, Decode, Load From File, Train)

Examples

Sentence Similarity with sentence-transformers/all-MiniLM-L6-v2

Steps:

  • Create Console app
dotnet new console --name Sentences
dotnet add package Microsoft.ML.OnnxRuntime
dotnet add package Tokenizers.HuggingFace
  • Add the following code to Program.cs
using System.Numerics;

using Microsoft.ML.OnnxRuntime;
using Microsoft.ML.OnnxRuntime.Tensors;

using Tokenizers.HuggingFace.Tokenizer;


var a = SentenceSimilarityModel.GetEmbeddings("Hello, world");
var b = SentenceSimilarityModel.GetEmbeddings("Hello, world, good to be here");

Console.WriteLine($"E: {string.Join(',', a)}");
Console.WriteLine($"a-b: {SentenceSimilarityModel.CosineSimilarity(a, b)}");

static class SentenceSimilarityModel
{
    static readonly Tokenizer tk = Tokenizer.FromFile("./tokenizer.json");
    static readonly InferenceSession session = new InferenceSession("./model.onnx");
    static (int, NamedOnnxValue[]) PrepareInputs(string text)
    {
        var encodings = tk.Encode(text, true, include_type_ids: true, include_attention_mask: true).Encodings[0];
        var sequenceLenght = encodings.Ids.Count;
        var input_ids = new DenseTensor<long>(encodings.Ids.Select(t => (long)t).ToArray(), [1, sequenceLenght]);
        var type_ids = new DenseTensor<long>(encodings.TypeIds.Select(t => (long)t).ToArray(), [1, sequenceLenght]);
        var attention_mask = new DenseTensor<long>(encodings.AttentionMask.Select(t => (long)t).ToArray(), [1, sequenceLenght]);

        return (sequenceLenght, [
            NamedOnnxValue.CreateFromTensor("input_ids", input_ids),
            NamedOnnxValue.CreateFromTensor("token_type_ids", type_ids),
            NamedOnnxValue.CreateFromTensor("attention_mask", attention_mask)
        ]);
    }
    static public float[] GetEmbeddings(string text)
    {
        var (sequenceLenght, inputs) = PrepareInputs(text);
        using IDisposableReadOnlyCollection<DisposableNamedOnnxValue> results = session.Run(inputs);
        var outputTensor = results.First().AsEnumerable<float>().ToArray();
        int subVector = 384 / Vector<float>.Count;
        float[] data = new float[384];
        for (int i = 0; i < sequenceLenght; i++)
        {
            for (int j = 0; j < subVector; j++)
            {
                Vector<float> result = new(data, j * Vector<float>.Count);
                result += new Vector<float>(outputTensor, i * 384 + j * Vector<float>.Count);
                result.CopyTo(data, j * Vector<float>.Count);
            }
        }
        for (int i = 0; i < subVector; i++)
        {
            Vector<float> result = new Vector<float>(data, i * Vector<float>.Count)/sequenceLenght;
            result.CopyTo(data, i * Vector<float>.Count);
        }
        return data;
    }
    static public double CosineSimilarity(float[] a, float[] b)
    {
        int subVector = 384 / Vector<float>.Count;
        double ab = 0, aa = 0, bb = 0;
        for (int i = 0; i < subVector; i++)
        {
            Vector<float> vecA = new(a, i * Vector<float>.Count);
            Vector<float> vecB = new(b, i * Vector<float>.Count);
            ab += Vector.Dot(vecA, vecB);
            aa += Vector.Dot(vecA, vecA);
            bb += Vector.Dot(vecB, vecB);
        }
        return ab / (Math.Sqrt(aa) * Math.Sqrt(bb));
    }
}

Releasing

If you know the target target you are building yout project for use:

dotnet build .\YourProject.csproj -c Release -r [target]

This way you avoid including all native libraries.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1-experimental.1 13 6/26/2025
1.0.0 228 5/10/2025
0.1.0 151 5/8/2025