Skip to content

Document that BpeOptions.ByteLevel requires a PreTokenizer #7716

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

Open
lunosia wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −0
Open

Document that BpeOptions.ByteLevel requires a PreTokenizer #7716

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53885de
Document that BpeOptions.ByteLevel requires a PreTokenizer
lunosia Sep 14, 2026
9d393fc
Update ByteLevel remarks per review feedback
lunosia Sep 18, 2026
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
8 changes: 8 additions & 0 deletions src/Microsoft.ML.Tokenizers/Model/BpeOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,14 @@ public BpeOptions(string vocabFile, string? mergesFile = null)
/// if true, the input text will be converted to UTF-8 bytes before encoding it.
/// Additionally, some ASCII characters will be transformed to different characters (e.g Space character will be transformed to 'Ġ' character).
/// </summary>
/// <remarks>
/// When this property is set to <see langword="true"/> and no pre-tokenizer is specified, the tokenizer falls
/// back to <c>PreTokenizer.CreateWordOrNonWord</c>, whose pattern does not cover whitespace characters. As
/// only the segments returned by the pre-tokenizer are encoded, whitespace is not preserved during
/// pre-tokenization and cannot be recovered by decoding.
/// To keep whitespace, set <see cref="PreTokenizer"/> to a pre-tokenizer whose pattern covers it, for example
/// a <see cref="RegexPreTokenizer"/> built from the GPT-2 pattern.
/// </remarks>
public bool ByteLevel { get; set; }

/// <summary>
Expand Down
Loading