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
zpczpc wants to merge 1 commit 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
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
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>
/// Byte-level encoding is normally paired with a byte-level pre-tokenizer. When this property is set to
/// <see langword="true"/>, <see cref="PreTokenizer"/> must be set as well.
/// On its own, byte-level encoding maps the space character to 'Ġ' but does not keep the whitespace attached
/// to the following token, so spaces and newlines are dropped during encoding and cannot be recovered by decoding.
/// Configuring a byte-level pre-tokenizer, for example <see cref="RegexPreTokenizer"/> built from the GPT-2
/// pattern, makes the round trip lossless.
/// </remarks>
public bool ByteLevel { get; set; }

/// <summary>
Expand Down