Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericstj merged 4 commits into from
Oct 1, 2025
Merged

Address the design review feedback #7513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3693275
Address the design review feedback
tarekgh Oct 1, 2025
628adb5
Apply suggestions from code review
tarekgh Oct 1, 2025
4763e43
Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs
tarekgh Oct 1, 2025
f80f3bf
Address the feedback
tarekgh Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
}

/// <summary>
/// Create a new Bpe tokenizer object to use for text encoding.
/// </summary>
/// <param name="options">The options used to create the Bpe tokenizer.</param>
/// <returns>The Bpe tokenizer object.</returns>
public static BpeTokenizer Create(BpeOptions options)
{
if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

foreach ((string token, int id) in options.Vocabulary)
foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
{
vocab.Add(new StringSpanOrdinalKey(token), id);
vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
}

if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
/// <summary>
/// Gets the optional beginning of sentence token.
/// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

/// <summary>
/// The id of the beginning of sentence token.
Expand Down
74 changes: 71 additions & 3 deletions src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
/// <summary>
/// Initializes a new instance of the <see cref="BpeOptions"/> class.
/// </summary>
public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
/// <param name="vocabulary">The vocabulary to use.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
{
if (vocabulary == null)
{
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
Vocabulary = vocabulary;
}

/// <summary>
Comment thread
tarekgh marked this conversation as resolved.
/// Initializes a new instance of the <see cref="BpeOptions"/> class.
/// </summary>
/// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
/// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
public BpeOptions(string vocabFile, string? mergesFile = null)
{
if (vocabFile is null)
{
throw new ArgumentNullException(nameof(vocabFile));
}

if (!File.Exists(vocabFile))
{
throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
}

using Stream vocabStream = File.OpenRead(vocabFile);
Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

if (dictionary is null)
{
throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
}

Vocabulary = dictionary;

if (mergesFile is not null)
{
if (!File.Exists(mergesFile))
{
throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
}

using Stream mergesStream = File.OpenRead(mergesFile);
using StreamReader reader = new(mergesStream);

List<string> merges = new();

int lineNumber = 0;
string? line;

while ((line = reader.ReadLine()) is not null)
{
lineNumber++;
if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
{
continue;
}

// validate the merges format
int index = line.IndexOf(' ');
if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
{
throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
}

merges.Add(line);
}

Merges = merges;
}
}

/// <summary>
/// Gets or sets the vocabulary to use.
/// </summary>
public IEnumerable<(string Token, int Id)> Vocabulary { get; }
public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

/// <summary>
/// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
/// <summary>
/// Gets or sets the optional special tokens to use.
/// </summary>
public Dictionary<string, int>? SpecialTokens { get; set; }
public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

/// <summary>
/// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
/// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
/// </summary>
/// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
/// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
/// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
/// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
/// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
/// <remarks>
/// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
/// </remarks>
public static SentencePieceTokenizer Create(
Stream modelStream,
bool addBeginOfSentence = true,
bool addBeginningOfSentence = true,
bool addEndOfSentence = false,
IReadOnlyDictionary<string, int>? specialTokens = null)
{
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
throw new ArgumentNullException(nameof(modelProto));
}

return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
}
}
}
2 changes: 2 additions & 0 deletions src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down
23 changes: 18 additions & 5 deletions test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
{
PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Normalizer = null,
UnknownToken = unknownToken,
ContinuingSubwordPrefix = continuingSubwordPrefix,
EndOfWordSuffix = endOfWordSuffix,
FuseUnknownTokens = fuseUnknownToken
};

bpe = BpeTokenizer.Create(bpeOptions);
SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
}
finally
{
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
}
}

BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
BpeOptions bpeOptions1 = new BpeOptions(vocab)
{
Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
FuseUnknownTokens = fuseUnknownToken
};

BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
}

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

bpe = BpeTokenizer.Create(
new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
new BpeOptions(dictionary!)
{
Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
});
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
return BpeTokenizer.Create(bpeOptions);
}

private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
{
foreach (JsonProperty token in vocabElement.EnumerateObject())
{
yield return (token.Name, token.Value.GetInt32());
yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
}
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Address the design review feedback#7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ericstj
merged 4 commits into

from

Oct 1, 2025
 Merged


Address the design review feedback
#7513
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3693275

Address the design review feedback


tarekgh Oct 1, 2025
628adb5

Apply suggestions from code review


tarekgh Oct 1, 2025
4763e43

Update src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs


tarekgh Oct 1, 2025
f80f3bf

Address the feedback


tarekgh Oct 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 8 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BPETokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,11 @@ public static BpeTokenizer Create(
 return new BpeTokenizer(result.vocab, result.merges, preTokenizer, normalizer, specialTokens, unknownToken, continuingSubwordPrefix, endOfWordSuffix, fuseUnknownTokens);
 }

 /// <summary>
 /// Create a new Bpe tokenizer object to use for text encoding.
 /// </summary>
 /// <param name="options">The options used to create the Bpe tokenizer.</param>
 /// <returns>The Bpe tokenizer object.</returns>
 public static BpeTokenizer Create(BpeOptions options)
 {
 if (options is null)
Expand All@@ -146,9 +151,9 @@ public static BpeTokenizer Create(BpeOptions options)

 Dictionary<StringSpanOrdinalKey, int> vocab = new Dictionary<StringSpanOrdinalKey, int>(1000);

 foreach ((string token, int id) in options.Vocabulary)
 foreach (KeyValuePair<string, int> kvp in options.Vocabulary)
 {
 vocab.Add(new StringSpanOrdinalKey(token), id);
 vocab.Add(new StringSpanOrdinalKey(kvp.Key), kvp.Value);
 }

 if (vocab.Count == 0)
Expand DownExpand Up@@ -395,7 +400,7 @@ private BpeTokenizer(
 /// <summary>
 /// Gets the optional beginning of sentence token.
 /// </summary>
internal string? BeginningOfSentenceToken { get; }
public string? BeginningOfSentenceToken { get; }

 /// <summary>
 /// The id of the beginning of sentence token.
Expand Down

74 changes: 71 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

namespace Microsoft.ML.Tokenizers
{
Expand All@@ -15,7 +17,9 @@ public sealed class BpeOptions
 /// <summary>
 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <param name="vocabulary">The vocabulary to use.</param>
 /// <exception cref="ArgumentNullException">Thrown when <paramref name="vocabulary"/> is null.</exception>
 public BpeOptions(IEnumerable<KeyValuePair<string, int>> vocabulary)
 {
 if (vocabulary == null)
 {
Expand All@@ -25,10 +29,74 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 Vocabulary = vocabulary;
 }

 /// <summary>
Comment thread
tarekgh marked this conversation as resolved.

 /// Initializes a new instance of the <see cref="BpeOptions"/> class.
 /// </summary>
 /// <param name="vocabFile">The JSON file path containing the dictionary of string keys and their ids.</param>
 /// <param name="mergesFile">The file path containing the tokens's pairs list.</param>
 public BpeOptions(string vocabFile, string? mergesFile = null)
 {
 if (vocabFile is null)
 {
 throw new ArgumentNullException(nameof(vocabFile));
 }

 if (!File.Exists(vocabFile))
 {
 throw new ArgumentException($"Could not find the vocabulary file '{vocabFile}'.");
 }

 using Stream vocabStream = File.OpenRead(vocabFile);
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(vocabStream);

 if (dictionary is null)
 {
 throw new InvalidOperationException($"The content of the vocabulary file '{vocabFile}' is not valid.");
 }

 Vocabulary = dictionary;

 if (mergesFile is not null)
 {
 if (!File.Exists(mergesFile))
 {
 throw new ArgumentException($"Could not find the merges file '{mergesFile}'.");
 }

 using Stream mergesStream = File.OpenRead(mergesFile);
 using StreamReader reader = new(mergesStream);

 List<string> merges = new();

 int lineNumber = 0;
 string? line;

 while ((line = reader.ReadLine()) is not null)
 {
 lineNumber++;
 if (line.StartsWith("#version", StringComparison.Ordinal) || line.Length == 0)
 {
 continue;
 }

 // validate the merges format
 int index = line.IndexOf(' ');
 if (index < 0 || index == line.Length - 1 || line.IndexOf(' ', index + 1) >= 0)
 {
 throw new InvalidOperationException($"Invalid merge file format at line: {lineNumber}");
 }

 merges.Add(line);
 }

 Merges = merges;
 }
 }

 /// <summary>
 /// Gets or sets the vocabulary to use.
 /// </summary>
 public IEnumerable<(string Token, int Id)> Vocabulary { get; }
 public IEnumerable<KeyValuePair<string, int>> Vocabulary { get; }

 /// <summary>
 /// Gets or sets the list of the merge strings used to merge tokens during encoding.
Expand All@@ -38,7 +106,7 @@ public BpeOptions(IEnumerable<(string Token, int Id)> vocabulary)
 /// <summary>
 /// Gets or sets the optional special tokens to use.
 /// </summary>
 public Dictionary<string, int>? SpecialTokens { get; set; }
 public IReadOnlyDictionary<string, int>? SpecialTokens { get; set; }

 /// <summary>
 /// Gets or sets the optional normalizer to normalize the input text before encoding it.
Expand Down

6 changes: 3 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/SentencePieceTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,15 +436,15 @@ public OperationStatus Decode(IEnumerable<int> ids, Span<char> destination, bool
 /// https://github.com/google/sentencepiece/blob/master/src/sentencepiece_model.proto.
 /// </summary>
 /// <param name="modelStream">The stream containing the SentencePiece Bpe or Unigram model.</param>
 /// <param name="addBeginOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addBeginningOfSentence">Indicate emitting the beginning of sentence token during the encoding.</param>
 /// <param name="addEndOfSentence">Indicate emitting the end of sentence token during the encoding.</param>
 /// <param name="specialTokens">The additional tokens to add to the vocabulary.</param>
 /// <remarks>
 /// When creating the tokenizer, ensure that the vocabulary stream is sourced from a trusted provider.
 /// </remarks>
 public static SentencePieceTokenizer Create(
 Stream modelStream,
 bool addBeginOfSentence = true,
 bool addBeginningOfSentence = true,
 bool addEndOfSentence = false,
 IReadOnlyDictionary<string, int>? specialTokens = null)
 {
Expand All@@ -455,7 +455,7 @@ public static SentencePieceTokenizer Create(
 throw new ArgumentNullException(nameof(modelProto));
 }

 return new SentencePieceTokenizer(modelProto, addBeginOfSentence, addEndOfSentence, specialTokens);
 return new SentencePieceTokenizer(modelProto, addBeginningOfSentence, addEndOfSentence, specialTokens);
 }
 }
}

2 changes: 2 additions & 0 deletions
src/Microsoft.ML.Tokenizers/PreTokenizer/CompositePreTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,8 @@
using System.Linq;
using System.Text.RegularExpressions;

namespace Microsoft.ML.Tokenizers;

/// <summary>
/// CompositePreTokenizer is a pre-tokenizer that applies multiple pre-tokenizers in sequence.
/// </summary>
Expand Down

23 changes: 18 additions & 5 deletions
test/Microsoft.ML.Tokenizers.Tests/BpeTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,6 +257,19 @@ public void SimpleTestWithUnknownToken(
 continuingSubwordPrefix: continuingSubwordPrefix, endOfWordSuffix: endOfWordSuffix, fuseUnknownTokens: fuseUnknownToken);

 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);

 BpeOptions bpeOptions = new BpeOptions(vocabFile, mergesFile)
 {
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
 Normalizer = null,
 UnknownToken = unknownToken,
 ContinuingSubwordPrefix = continuingSubwordPrefix,
 EndOfWordSuffix = endOfWordSuffix,
 FuseUnknownTokens = fuseUnknownToken
 };

 bpe = BpeTokenizer.Create(bpeOptions);
 SimpleWithUnknownTokenTest(bpe, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }
 finally
 {
Expand All@@ -267,7 +280,7 @@ public void SimpleTestWithUnknownToken(
 }
 }

 BpeOptions bpeOptions = new BpeOptions(vocab.Select(kvp => (kvp.Key, kvp.Value)))
 BpeOptions bpeOptions1 = new BpeOptions(vocab)
 {
 Merges = merges?.Select(kvp => $"{kvp.Item1} {kvp.Item2}"),
 PreTokenizer = PreTokenizer.CreateWordOrNonWord(),
Expand All@@ -278,7 +291,7 @@ public void SimpleTestWithUnknownToken(
 FuseUnknownTokens = fuseUnknownToken
 };

 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions);
 BpeTokenizer bpe1 = BpeTokenizer.Create(bpeOptions1);
 SimpleWithUnknownTokenTest(bpe1, sentence, offsets, ids, expectedTokens, decodedTokens, decodedTokensWithoutUnknownToken);
 }

Expand DownExpand Up@@ -387,7 +400,7 @@ public async Task TestBpeCreation()
 Dictionary<string, int>? dictionary = JsonSerializer.Deserialize<Dictionary<string, int>>(jsonString);

 bpe = BpeTokenizer.Create(
 new BpeOptions(dictionary!.Select(kvp => (kvp.Key, kvp.Value)))
 new BpeOptions(dictionary!)
 {
 Merges = File.ReadAllLines(mergesFile).Skip(1).ToArray() // Skip the first line which is the header "#version".
 });
Expand DownExpand Up@@ -928,11 +941,11 @@ private static BpeTokenizer CreateBpeTokenizerFromJson()
 return BpeTokenizer.Create(bpeOptions);
 }

 private static IEnumerable<(string Token, int Id)> GetVocabulary(JsonElement vocabElement)
 private static IEnumerable<KeyValuePair<string, int>> GetVocabulary(JsonElement vocabElement)
 {
 foreach (JsonProperty token in vocabElement.EnumerateObject())
 {
 yield return (token.Name, token.Value.GetInt32());
 yield return new KeyValuePair<string, int>(token.Name, token.Value.GetInt32());
 }
 }

Expand Down