Phi-4 Tokenizer Support#7396

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
tarekgh merged 1 commit into from
Feb 23, 2025
Merged

Phi-4 Tokenizer Support #7396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
-->
<TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
</ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
-->
<TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
</ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
-->
<TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
</ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
-->
<TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
</ItemGroup>
Expand Down
19 changes: 16 additions & 3 deletions src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
private const string FimMiddle = "<|fim_middle|>";
private const string FimSuffix = "<|fim_suffix|>";
private const string EndOfPrompt = "<|endofprompt|>";
private const string IMStart = "<|im_start|>";
private const string IMEnd = "<|im_end|>";
private const string IMSep = "<|im_sep|>";

private enum ModelEncoding
{
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
O200kBase
}

private const string Phi4ModelName = "phi-4";

private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
[
// chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
{ "code-search-ada-code-001", ModelEncoding.R50kBase },

// open source
{ "gpt2", ModelEncoding.GPT2 }
{ "gpt2", ModelEncoding.GPT2 },

// phi-4
{ Phi4ModelName, ModelEncoding.Cl100kBase },
};

private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
switch (modelEncoding)
{
case ModelEncoding.Cl100kBase:
return (new Dictionary<string, int>
{ { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
return (
Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
{ IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
} :
new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

case ModelEncoding.GPT2:
return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down
20 changes: 19 additions & 1 deletion test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
{
const string IMStart = "<|im_start|>";
const string IMEnd = "<|im_end|>";
const string IMSep = "<|im_sep|>";

private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
{
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

[Fact]
public async Task TestTokenizerCreation()
{
TestGPT4TokenizationEncoding(GPT4);
TestGPT4TokenizationEncoding(Phi4);

Assert.True(GPT4 is TiktokenTokenizer);
IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
[InlineData("code-search-babbage-code-001")]
[InlineData("code-search-ada-code-001")]
[InlineData("gpt2")]
[InlineData("phi-4")]
public void TestAllSupportedModelNames(string modelName)
{
Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
[InlineData("text-davinci-003")]
[InlineData("text-curie-001")]
[InlineData("text-davinci-edit-001")]
[InlineData("phi-4")]
[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void TestCreationUsingModel(string modelName)
{
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
[MemberData(nameof(TokenizerTestData))]
public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
{
Tokenizer tokenizer = GPT4;
TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
}

private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
{
IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
}
}

[Fact]
public void TestPhi4SpecialCases()
{
string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
Assert.Equal(text, Phi4.Decode(encoded));
}

// We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
=> typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
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
Phi-4 Tokenizer Support#7396

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

tarekgh
merged 1 commit into

from

Feb 23, 2025
 Merged


Phi-4 Tokenizer Support
#7396
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.Gpt2/Microsoft.ML.Tokenizers.Data.Gpt2.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,10 @@
 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 Gpt2 vocab data is exact as the r50k_base vocab data, but with a different name.
 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\gpt2.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.O200kBase/Microsoft.ML.Tokenizers.Data.O200kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\o200k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.P50kBase/Microsoft.ML.Tokenizers.Data.P50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\p50k_base.tiktoken" />
 </ItemGroup>
Expand Down

4 changes: 2 additions & 2 deletions
src/Microsoft.ML.Tokenizers.Data.R50kBase/Microsoft.ML.Tokenizers.Data.R50kBase.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,10 +15,10 @@

 The file under MIT copyright license https://github.com/openai/tiktoken/blob/main/LICENSE

 In the CompressFile task above we modify the file's content to elimenate the ranks, thus reducing the file size,
 In the CompressFile task above we modify the file's content to eliminate the ranks, thus reducing the file size,
 since the rank corresponds to the line number in the file. For the file p50k_base.tiktoken,
 we introduce empty lines to replace any missing ranks, ensuring that the rank consistently aligns with the line number.
 After we eleminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 After we eliminate the ranks from the file, we compress the file using the DeflateStream and embed it as a resource in the assembly.
 -->
 <TokenizerDataEmbeddedResource Include="Data\r50k_base.tiktoken" />
 </ItemGroup>
Expand Down

19 changes: 16 additions & 3 deletions
src/Microsoft.ML.Tokenizers/Model/TiktokenTokenizer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1010,6 +1010,9 @@ public override OperationStatus Decode(IEnumerable<int> ids, Span<char> destinat
 private const string FimMiddle = "<|fim_middle|>";
 private const string FimSuffix = "<|fim_suffix|>";
 private const string EndOfPrompt = "<|endofprompt|>";
 private const string IMStart = "<|im_start|>";
 private const string IMEnd = "<|im_end|>";
 private const string IMSep = "<|im_sep|>";

 private enum ModelEncoding
 {
Expand All@@ -1022,6 +1025,8 @@ private enum ModelEncoding
 O200kBase
 }

 private const string Phi4ModelName = "phi-4";

 private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixToEncoding =
 [
 // chat
Expand DownExpand Up@@ -1090,7 +1095,10 @@ private static readonly (string Prefix, ModelEncoding Encoding)[] _modelPrefixTo
 { "code-search-ada-code-001", ModelEncoding.R50kBase },

 // open source
 { "gpt2", ModelEncoding.GPT2 }
 { "gpt2", ModelEncoding.GPT2 },

 // phi-4
 { Phi4ModelName, ModelEncoding.Cl100kBase },
 };

 private static ModelEncoding GetModelEncoding(string modelName)
Expand DownExpand Up@@ -1122,8 +1130,13 @@ private static (Dictionary<string, int> SpecialTokens, Regex Regex, string Vocab
 switch (modelEncoding)
 {
 case ModelEncoding.Cl100kBase:
 return (new Dictionary<string, int>
 { { EndOfText, 100257}, { FimPrefix, 100258}, { FimMiddle, 100259}, { FimSuffix, 100260}, { EndOfPrompt, 100276} }, Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);
 return (
 Phi4ModelName.Equals(modelName, StringComparison.OrdinalIgnoreCase) ?
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 }, { IMStart, 100264 },
 { IMEnd, 100265 }, { IMSep, 100266 }, { "<|dummy_85|>", 100349}, // <|dummy_85|> is used for padding according to the phi-4 special token mapping.
 } :
 new Dictionary<string, int> { { EndOfText, 100257 }, { FimPrefix, 100258 }, { FimMiddle, 100259 }, { FimSuffix, 100260 }, { EndOfPrompt, 100276 } },
 Cl100kBaseRegex(), Cl100kBaseVocabFile, Type.GetType(Cl100kBaseTypeName), Cl100kBasePackageName);

 case ModelEncoding.GPT2:
 return (new Dictionary<string, int> { { EndOfText, 50256 }, }, P50kBaseRegex(), GPT2File, Type.GetType(Gpt2TypeName), Gpt2PackageName);
Expand Down

20 changes: 19 additions & 1 deletion
test/Microsoft.ML.Tokenizers.Tests/TiktokenTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ public class TiktokenTests
 {
 const string IMStart = "<|im_start|>";
 const string IMEnd = "<|im_end|>";
 const string IMSep = "<|im_sep|>";

 private static readonly Dictionary<string, int> _specialTokens = new Dictionary<string, int>
 {
Expand All@@ -34,11 +35,13 @@ public class TiktokenTests
 public static Tokenizer R50kBase { get; } = TiktokenTokenizer.CreateForModel("ada");
 public static Tokenizer P50kEdit { get; } = TiktokenTokenizer.CreateForModel("text-davinci-edit-001");
 public static Tokenizer GPT4o { get; } = TiktokenTokenizer.CreateForModel("gpt-4o");
 public static Tokenizer Phi4 { get; } = TiktokenTokenizer.CreateForModel("phi-4");

 [Fact]
 public async Task TestTokenizerCreation()
 {
 TestGPT4TokenizationEncoding(GPT4);
 TestGPT4TokenizationEncoding(Phi4);

 Assert.True(GPT4 is TiktokenTokenizer);
 IReadOnlyDictionary<string, int>? specialTokens = (GPT4 as TiktokenTokenizer)!.SpecialTokens;
Expand DownExpand Up@@ -443,6 +446,7 @@ public void TestEncodeR50kBase()
 [InlineData("code-search-babbage-code-001")]
 [InlineData("code-search-ada-code-001")]
 [InlineData("gpt2")]
 [InlineData("phi-4")]
 public void TestAllSupportedModelNames(string modelName)
 {
 Tokenizer tokenizer = TiktokenTokenizer.CreateForModel(modelName);
Expand DownExpand Up@@ -504,6 +508,7 @@ public void TestEncodingNamesNegativeCases()
 [InlineData("text-davinci-003")]
 [InlineData("text-curie-001")]
 [InlineData("text-davinci-edit-001")]
 [InlineData("phi-4")]
 [ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
 public void TestCreationUsingModel(string modelName)
 {
Expand DownExpand Up@@ -568,8 +573,12 @@ public static IEnumerable<object?[]> TokenizerTestData
 [MemberData(nameof(TokenizerTestData))]
 public void TestTokenizerEncoding(string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 Tokenizer tokenizer = GPT4;
 TestTokenizerEncodingForTokenizer(GPT4, text, expectedTokens, expectedOffsets, expectedIds);
 TestTokenizerEncodingForTokenizer(Phi4, text, expectedTokens, expectedOffsets, expectedIds);
 }

 private void TestTokenizerEncodingForTokenizer(Tokenizer tokenizer, string text, string[] expectedTokens, (int Index, int Length)[] expectedOffsets, int[] expectedIds)
 {
 IReadOnlyList<EncodedToken> encoding = tokenizer.EncodeToTokens(text, out _);
 IReadOnlyList<EncodedToken> encoding1 = tokenizer.EncodeToTokens(text.AsSpan(), out _);

Expand DownExpand Up@@ -734,6 +743,15 @@ public void TestPreciseTokenLimits(string text, string[] expectedTokens, (int In
 }
 }

 [Fact]
 public void TestPhi4SpecialCases()
 {
 string text = $"{IMStart}Hello{IMSep} World{IMEnd}<|dummy_85|>";
 IReadOnlyList<int> encoded = Phi4.EncodeToIds(text);
 Assert.Equal(new List<int>() { 100264, 9906, 100266, 4435, 100265, 100349 }, encoded);
 Assert.Equal(text, Phi4.Decode(encoded));
 }

 // We are not exposing the Encoder, Decoder, or Vocabulary so far. For now, use reflection to test it.
 private static IReadOnlyDictionary<ReadOnlyMemory<byte>, int>? GetEncoder(TiktokenTokenizer tiktoken)
 => typeof(TiktokenTokenizer).GetProperty("Encoder", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(tiktoken) as IReadOnlyDictionary<ReadOnlyMemory<byte>, int>;
Expand Down