Home
Docs
Github
Blog
0.1.24
Get Started
Installation
Quick Start
Tutorials
Constrained Decoding
Workflow of XGrammar
Advanced Topics
Structural Tag Usage
Advanced Topics of the Structural Tag
Integration with LLM Engine
JSON Generation
EBNF-Guided Generation
XGrammar Features
Runtime Safeguards
Serialization
JavaScript API
Developer Guide
Building Docs
Code Coverage
API Reference
XGrammar Python API
Table of Contents
Docs
>
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
X
_
__init__() (xgrammar.GrammarCompiler method)
(xgrammar.GrammarMatcher method)
(xgrammar.TokenizerInfo method)
__str__() (xgrammar.Grammar method)
_ebnf_to_grammar_no_normalization() (in module xgrammar.testing)
_generate_float_regex() (in module xgrammar.testing)
_generate_range_regex() (in module xgrammar.testing)
_get_allow_empty_rule_ids() (in module xgrammar.testing)
_get_masked_tokens_from_bitmask() (in module xgrammar.testing)
_get_matcher_from_grammar() (in module xgrammar.testing)
_get_matcher_from_grammar_and_tokenizer_info() (in module xgrammar.testing)
_is_grammar_accept_string() (in module xgrammar.testing)
_is_single_token_bitmask() (in module xgrammar.testing)
_json_schema_to_ebnf() (in module xgrammar.testing)
_print_grammar_fsms() (in module xgrammar.testing)
_qwen_xml_tool_calling_to_ebnf() (in module xgrammar.testing)
_regex_to_ebnf() (in module xgrammar.testing)
A
accept_string() (xgrammar.GrammarMatcher method)
accept_token() (xgrammar.GrammarMatcher method)
add_prefix_space (xgrammar.TokenizerInfo property)
allocate_token_bitmask() (in module xgrammar)
AnyTextFormat (class in xgrammar.structural_tag)
apply_token_bitmask_inplace() (in module xgrammar)
at_least_one (xgrammar.structural_tag.TagsWithSeparatorFormat attribute)
(xgrammar.structural_tag.TriggeredTagsFormat attribute)
B
begin (xgrammar.structural_tag.StructuralTagItem attribute)
(xgrammar.structural_tag.TagFormat attribute)
bitmask_dtype (in module xgrammar)
bitmask_to_bool_mask() (in module xgrammar.testing)
bool_mask_to_bitmask() (in module xgrammar.testing)
builtin_json_grammar() (xgrammar.Grammar static method)
BYTE_FALLBACK (xgrammar.VocabType attribute)
BYTE_LEVEL (xgrammar.VocabType attribute)
byte_string_fuser() (xgrammar.testing.GrammarFunctor static method)
C
cache_limit_bytes (xgrammar.GrammarCompiler property)
clear_cache() (xgrammar.GrammarCompiler method)
compile_builtin_json_grammar() (xgrammar.GrammarCompiler method)
compile_grammar() (xgrammar.GrammarCompiler method)
compile_json_schema() (xgrammar.GrammarCompiler method)
compile_regex() (xgrammar.GrammarCompiler method)
compile_structural_tag() (xgrammar.GrammarCompiler method)
CompiledGrammar (class in xgrammar)
concat() (xgrammar.Grammar static method)
ConstStringFormat (class in xgrammar.structural_tag)
content (xgrammar.structural_tag.TagFormat attribute)
D
dead_code_eliminator() (xgrammar.testing.GrammarFunctor static method)
decoded_vocab (xgrammar.TokenizerInfo property)
deserialize_json() (xgrammar.CompiledGrammar static method)
(xgrammar.Grammar static method)
(xgrammar.TokenizerInfo static method)
DeserializeFormatError (class in xgrammar.exception)
DeserializeVersionError (class in xgrammar.exception)
dump_metadata() (xgrammar.TokenizerInfo method)
E
elements (xgrammar.structural_tag.OrFormat attribute)
(xgrammar.structural_tag.SequenceFormat attribute)
end (xgrammar.structural_tag.StructuralTagItem attribute)
(xgrammar.structural_tag.TagFormat attribute)
F
fill_next_token_bitmask() (xgrammar.GrammarMatcher method)
find_jump_forward_string() (xgrammar.GrammarMatcher method)
Format (in module xgrammar.structural_tag)
format (xgrammar.structural_tag.StructuralTag attribute)
from_ebnf() (xgrammar.Grammar static method)
from_huggingface() (xgrammar.TokenizerInfo static method)
from_json() (xgrammar.structural_tag.StructuralTag static method)
from_json_schema() (xgrammar.Grammar static method)
from_legacy_structural_tag() (xgrammar.structural_tag.StructuralTag static method)
from_regex() (xgrammar.Grammar static method)
from_structural_tag() (xgrammar.Grammar static method)
from_vocab_and_metadata() (xgrammar.TokenizerInfo static method)
G
get_bitmask_shape() (in module xgrammar)
get_cache_size_bytes() (xgrammar.GrammarCompiler method)
get_max_recursion_depth() (in module xgrammar)
get_serialization_version() (in module xgrammar)
Grammar (class in xgrammar)
grammar (xgrammar.CompiledGrammar property)
GrammarCompiler (class in xgrammar)
GrammarFunctor (class in xgrammar.testing)
GrammarMatcher (class in xgrammar)
I
InvalidJSONError (class in xgrammar.exception)
InvalidStructuralTagError (class in xgrammar.exception)
is_terminated() (xgrammar.GrammarMatcher method)
J
json_schema (xgrammar.structural_tag.JSONSchemaFormat attribute)
(xgrammar.structural_tag.QwenXMLParameterFormat attribute)
JSONSchemaFormat (class in xgrammar.structural_tag)
L
lookahead_assertion_analyzer() (xgrammar.testing.GrammarFunctor static method)
M
max_recursion_depth() (in module xgrammar)
max_rollback_tokens (xgrammar.GrammarMatcher property)
memory_size_bytes (xgrammar.CompiledGrammar property)
module
xgrammar.testing
O
OrFormat (class in xgrammar.structural_tag)
P
prepend_space_in_tokenization (xgrammar.TokenizerInfo property)
Q
QwenXMLParameterFormat (class in xgrammar.structural_tag)
R
RAW (xgrammar.VocabType attribute)
reset() (xgrammar.GrammarMatcher method)
reset_token_bitmask() (in module xgrammar)
rollback() (xgrammar.GrammarMatcher method)
rule_inliner() (xgrammar.testing.GrammarFunctor static method)
S
schema_ (xgrammar.structural_tag.StructuralTagItem attribute)
separator (xgrammar.structural_tag.TagsWithSeparatorFormat attribute)
SequenceFormat (class in xgrammar.structural_tag)
serialize_json() (xgrammar.CompiledGrammar method)
(xgrammar.Grammar method)
(xgrammar.TokenizerInfo method)
set_max_recursion_depth() (in module xgrammar)
special_token_ids (xgrammar.TokenizerInfo property)
stop_after_first (xgrammar.structural_tag.TagsWithSeparatorFormat attribute)
(xgrammar.structural_tag.TriggeredTagsFormat attribute)
stop_token_ids (xgrammar.GrammarMatcher property)
(xgrammar.TokenizerInfo property)
StructuralTag (class in xgrammar.structural_tag)
StructuralTagItem (class in xgrammar.structural_tag)
structure_normalizer() (xgrammar.testing.GrammarFunctor static method)
T
TagFormat (class in xgrammar.structural_tag)
tags (xgrammar.structural_tag.TagsWithSeparatorFormat attribute)
(xgrammar.structural_tag.TriggeredTagsFormat attribute)
TagsWithSeparatorFormat (class in xgrammar.structural_tag)
tokenizer_info (xgrammar.CompiledGrammar property)
TokenizerInfo (class in xgrammar)
TriggeredTagsFormat (class in xgrammar.structural_tag)
triggers (xgrammar.structural_tag.TriggeredTagsFormat attribute)
type (xgrammar.structural_tag.AnyTextFormat attribute)
(xgrammar.structural_tag.ConstStringFormat attribute)
(xgrammar.structural_tag.JSONSchemaFormat attribute)
(xgrammar.structural_tag.OrFormat attribute)
(xgrammar.structural_tag.QwenXMLParameterFormat attribute)
(xgrammar.structural_tag.SequenceFormat attribute)
(xgrammar.structural_tag.StructuralTag attribute)
(xgrammar.structural_tag.TagFormat attribute)
(xgrammar.structural_tag.TagsWithSeparatorFormat attribute)
(xgrammar.structural_tag.TriggeredTagsFormat attribute)
U
union() (xgrammar.Grammar static method)
V
value (xgrammar.structural_tag.ConstStringFormat attribute)
vocab_size (xgrammar.TokenizerInfo property)
vocab_type (xgrammar.TokenizerInfo property)
VocabType (class in xgrammar)
X
xgrammar.testing
module