Repository navigation
Expand file tree
/
Copy pathzensical.toml
More file actions
404 lines (378 loc) · 17.5 KB
/
Copy pathzensical.toml
File metadata and controls
404 lines (378 loc) · 17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# ============================================================================
# Zensical Configuration for Google DeepMind Gemma Documentation
# ============================================================================
[project]
site_name = "Gemma Documentation"
site_description = "Gemma open model documentation by Google DeepMind"
site_author = "Google DeepMind"
site_url = "https://gemma.ai"
copyright = """
Copyright © 2026 Google DeepMind
"""
# Order matters: the token layer must load first, motion last.
extra_css = [
"stylesheets/gemma.css?v=2", # tokens: palette, spacing, radius, shadow
"stylesheets/layout.css?v=2", # page grid, sidebars, typography scale
"stylesheets/nav.css?v=2", # header, tabs, sidebar, table of contents
"stylesheets/content.css?v=2", # tables, admonitions, code, tabs
"stylesheets/components.css?v=2", # cards, badges, figures, steps, embeds
"stylesheets/icons.css?v=2", # inlined icon-set SVGs and card icons
"stylesheets/engine-grid.css?v=2", # quickstart: the "run it with" engine grid
"stylesheets/model-tree.css?v=2", # models overview: the family lineage tree
"stylesheets/embeds.css?v=2", # external interactive demos
"stylesheets/page-context.css?v=2",# the applicability bar above every H1
"stylesheets/tokens.css?v=2", # chat-token badges
"stylesheets/tuning-map.css?v=3", # interactive fine-tuning pipeline map
"stylesheets/home.css?v=3", # landing page: chrome, backdrop, hero
"stylesheets/llm-tutorial.css", # interactive "How LLMs work" tutorial widgets
"stylesheets/llm-animations.css", # keyframes & motion choreography for LLM tutorial widgets
"stylesheets/llm-shell.css?v=1", # interactive tour shell: viewport lock, stage rail, hero
"stylesheets/llm-stage.css?v=1", # interactive tour stage: glass stage cards and nav buttons
"stylesheets/llm-terminal.css?v=1",# interactive tour drawer: bottom reading terminal
"stylesheets/motion.css?v=2", # transitions + reduced-motion opt-out
]
# Order matters: the generated data must load before the switcher that reads it.
# All entries use `defer = true` so scripts stay non-render-blocking while preserving execution order.
extra_javascript = [
{ path = "javascripts/model-data.js?v=2", defer = true }, # GENERATED from data/models.yml -- do not edit
{ path = "javascripts/model-switcher.js?v=3", defer = true }, # page context strip selector + code rewriting
{ path = "javascripts/tuning-map.js?v=3", defer = true }, # interactive fine-tuning map & path picker
{ path = "javascripts/llm-tutorial.js", defer = true }, # interactive "How LLMs work" tutorial widgets
{ path = "javascripts/llm-ascii-shell.js?v=1", defer = true },# interactive tour shell: ASCII canvas, stage rail, terminal
{ path = "javascripts/mathjax.js", defer = true },
{ path = "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js", defer = true },
]
# `include_yaml` exposes data/models.yml as `modeldata.*` in page templates. NOT `models.*`:
# every page carries a `models:` frontmatter key, and page metadata shadows a macros variable
# of the same name -- which silently broke both generated tables. See data/models.yml
# for what reads it. Hand-editing a model table in a page is a bug; change the data file.
plugins = { macros = { enabled = true, include_yaml = { modeldata = "data/models.yml", frameworkdata = "data/frameworks.yml" } } }
# ============================================================================
# NAVIGATION
# ============================================================================
nav = [
{ "Home" = "index.md" },
# ---------------------------------------------------------------------------
# Capabilities live here, not in their own tab: they are fundamental Gemma 4
# capabilities and belong where the full picture is visible at once.
# ---------------------------------------------------------------------------
{ "Get started" = [
{ "Quickstart" = "get-started/index.md" },
{ "Best practices" = "get-started/best-practices.md" },
{ "Text" = [
"get-started/capabilities/text.md",
"get-started/capabilities/thinking.md",
"get-started/capabilities/function-calling.md",
]},
{ "Multimodal" = [
"get-started/capabilities/vision.md",
"get-started/capabilities/image.md",
"get-started/capabilities/video.md",
"get-started/capabilities/audio.md",
]},
# Advanced holds the tuning-and-internals material -- MTP, QAT and the
# prompt-format references -- so the main list stays what a newcomer needs
# first: how to run it and how to run it well, then the capability groups.
{ "Advanced" = [
{ "Prompt formatting" = "get-started/prompt-formatting.md" },
{ "Multi-Token Prediction" = "get-started/capabilities/mtp.md" },
{ "Quantization-Aware Training" = "get-started/qat.md" },
]},
]},
# ---------------------------------------------------------------------------
# Model-card centric on purpose. Grouping is presentation only -- the
# directories stay flat so a model's URL never changes when it is
# reclassified (see PLAN.md, "Open decision for Step 2.1").
# ---------------------------------------------------------------------------
{ "Models" = [
{ "Overview" = "models/index.md" },
{ "Gemma 4" = [
{ "Overview" = "models/gemma-4/index.md" },
{ "Model card" = "models/gemma-4/model-card.md" },
]},
{ "Previous generations" = [
{ "Gemma 3" = "models/gemma-3/index.md" },
{ "Gemma 2" = "models/gemma-2/index.md" },
{ "Gemma" = "models/gemma-1/index.md" },
]},
{ "Variants" = [
{ "Gemma 3n" = [
{ "Overview" = "models/gemma-3n/index.md" },
{ "Model card" = "models/gemma-3n/model-card.md" },
]},
{ "DiffusionGemma" = [
{ "Overview" = "models/diffusiongemma/index.md" },
{ "Model card" = "models/diffusiongemma/model-card.md" },
{ "Diffusion explained" = "models/diffusiongemma/explained.md" },
{ "Generate output" = "models/diffusiongemma/inference.md" },
]},
{ "FunctionGemma" = [
{ "Overview" = "models/functiongemma/index.md" },
{ "Model card" = "models/functiongemma/model-card.md" },
{ "Formatting and best practices" = "models/functiongemma/formatting.md" },
{ "Function calling with HF" = "models/functiongemma/inference.md" },
{ "Full sequence" = "models/functiongemma/full-sequence.md" },
{ "Fine-tuning" = "models/functiongemma/fine-tuning.md" },
]},
{ "EmbeddingGemma" = [
{ "Overview" = "models/embeddinggemma/index.md" },
{ "EmbeddingGemma model card" = "models/embeddinggemma/model-card-v1.md" },
{ "EmbeddingGemma 2 model card" = "models/embeddinggemma/model-card-v2.md" },
{ "Generate embeddings" = "models/embeddinggemma/inference.md" },
{ "Multimodal embeddings" = "models/embeddinggemma/multimodal.md" },
{ "Fine-tuning" = "models/embeddinggemma/fine-tuning.md" },
{ "Multimodal fine-tuning" = "models/embeddinggemma/fine-tuning-multimodal.md" },
]},
{ "PaliGemma" = [
{ "Overview" = "models/paligemma/index.md" },
{ "PaliGemma model card" = "models/paligemma/model-card-v1.md" },
{ "PaliGemma 2 model card" = "models/paligemma/model-card-v2.md" },
{ "Prompting & system instructions" = "models/paligemma/prompting.md" },
{ "Generate output with Keras" = "models/paligemma/inference.md" },
{ "Fine-tuning with JAX" = "models/paligemma/fine-tuning.md" },
]},
{ "ShieldGemma" = [
{ "Overview" = "models/shieldgemma/index.md" },
{ "ShieldGemma model card" = "models/shieldgemma/model-card-v1.md" },
{ "ShieldGemma 2 model card" = "models/shieldgemma/model-card-v2.md" },
]},
]},
{ "Research" = [
{ "RecurrentGemma" = [
{ "Overview" = "models/recurrentgemma/index.md" },
{ "Model card" = "models/recurrentgemma/model-card.md" },
{ "Generate output with JAX" = "models/recurrentgemma/inference.md" },
{ "Fine-tuning with JAX" = "models/recurrentgemma/fine-tuning.md" },
]},
{ "DataGemma" = "models/datagemma/index.md" },
{ "Gemma Scope" = "models/gemma-scope/index.md" },
{ "Gemma APS" = "models/gemma-aps/index.md" },
]},
{ "Releases" = "models/releases.md" },
]},
# ---------------------------------------------------------------------------
# Split by intent -- where you run it -- rather than by vendor.
# ---------------------------------------------------------------------------
# Nav labels are short on purpose -- page H1s stay as written ("Run Gemma with
# Hugging Face Transformers"), but the sidebar shows just the engine name.
{ "Run" = [
{ "Overview" = "deployment/index.md" },
{ "Local" = [
{ "Ollama" = "deployment/ollama.md" },
{ "llama.cpp" = "deployment/llamacpp.md" },
{ "LM Studio" = "deployment/lmstudio.md" },
{ "MLX" = "deployment/mlx.md" },
{ "Hugging Face Transformers" = "deployment/huggingface.md" },
{ "Keras" = "deployment/keras.md" },
{ "LiteRT-LM" = "deployment/litert.md" },
{ "AI Edge Gallery" = "deployment/ai-edge-gallery.md" },
]},
{ "Serve" = [
{ "vLLM" = "deployment/vllm.md" },
{ "SGLang" = "deployment/sglang.md" },
{ "Gemini API" = "deployment/gemini-api.md" },
{ "Google Cloud" = "deployment/google-cloud.md" },
]},
{ "Frameworks" = [
{ "LangChain" = "deployment/langchain.md" },
{ "Unsloth" = "deployment/unsloth.md" },
]},
]},
{ "Fine-tune" = [
{ "Overview" = "tuning/index.md" },
{ "Foundations" = [
{ "Best practices" = "tuning/best-practices.md" },
{ "Dataset formatting" = "tuning/datasets-formatting.md" },
]},
{ "Continued pre-training" = [
{ "Continued pre-training" = "tuning/continued-pretraining.md" },
{ "Custom chat templates" = "tuning/custom-chat-template.md" },
]},
{ "Supervised fine-tuning" = [
{ "(Q)LoRA" = "tuning/qlora.md" },
{ "Full fine-tuning" = "tuning/full-finetune.md" },
{ "MoE fine-tuning" = "tuning/moe-finetune.md" },
{ "Unused tokens" = "tuning/unused-tokens.md" },
]},
{ "Multimodal fine-tuning" = [
{ "Vision fine-tuning" = "tuning/vision-qlora.md" },
{ "Audio fine-tuning" = "tuning/audio-qlora.md" },
]},
{ "Reinforcement learning" = [
{ "Preference optimization" = "tuning/preference-alignment.md" },
{ "Verifiable rewards" = "tuning/reinforcement-learning.md" },
]},
{ "Deployment" = [
{ "Scaling" = "tuning/scaling.md" },
{ "Export" = "tuning/export.md" },
{ "Unsloth" = "tuning/unsloth.md" },
{ "Gemma trainer skill" = "tuning/gemma-trainer.md" },
]},
]},
{ "Learn" = [
{ "Overview" = "learn/index.md" },
{ "Interactive guides" = [
{ "How LLMs work" = "learn/how-llms-work.md" },
]},
{ "Visual guides" = [
{ "Gemma 4" = "tutorials/visual-guides/gemma-4.md" },
{ "Gemma 4 12B" = "tutorials/visual-guides/gemma-4-12b.md" },
{ "Multi-Token Prediction" = "tutorials/visual-guides/mtp.md" },
{ "DiffusionGemma" = "tutorials/visual-guides/diffusiongemma.md" },
]},
{ "Gemma explained" = [
{ "Overview" = "tutorials/gemma-explained/overview.md" },
{ "What's new in Gemma 2" = "tutorials/gemma-explained/gemma-2.md" },
{ "RecurrentGemma" = "tutorials/gemma-explained/recurrentgemma.md" },
{ "PaliGemma" = "tutorials/gemma-explained/paligemma.md" },
{ "What's new in Gemma 3" = "tutorials/gemma-explained/gemma-3.md" },
{ "EmbeddingGemma" = "tutorials/gemma-explained/embeddinggemma.md" },
]},
]},
# ---------------------------------------------------------------------------
# One tab for everything that sits beside the documentation: the old Demos and
# Ecosystem tabs, plus the notebook and external-link directory. Its index is
# card-driven so a new demo or link is one entry, not a new nav level.
# ---------------------------------------------------------------------------
{ "Resources" = [
{ "Overview" = "resources/index.md" },
{ "Demos & tools" = [
{ "Gemma Skills" = "resources/gemma-skills.md" },
{ "AIventure" = "resources/aiventure.md" },
{ "Vision token budget" = "resources/vision-token-budget.md" },
{ "Embedding Draw Challenge" = "resources/embedding-draw-challenge.md" },
]},
{ "Legal" = [
{ "Gemma 4 license" = "resources/apache-2.md" },
{ "Terms of use" = "resources/terms.md" },
{ "Terms archive" = [
{ "Overview" = "resources/terms-archive/index.md" },
{ "April 1, 2024" = "resources/terms-archive/terms_04_01_24.md" },
{ "February 21, 2024" = "resources/terms-archive/terms_02_21_24.md" },
]},
{ "Prohibited use" = "resources/prohibited-use.md" },
{ "Intended use statement" = "resources/intended-use.md" },
]},
]},
]
# ============================================================================
# FOOTER
# ============================================================================
# Rendered by the theme's footer as icon links. Every icon below ships with
# Zensical (.icons/fontawesome/brands/), so none of these need a vendored SVG.
[[project.extra.social]]
icon = "fontawesome/brands/x-twitter"
link = "https://x.com/googlegemma"
name = "Gemma on X"
[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/google-gemma"
name = "Gemma on GitHub"
[[project.extra.social]]
icon = "fontawesome/brands/hugging-face"
link = "https://huggingface.co/collections/google/gemma-4"
name = "Gemma 4 on Hugging Face"
[[project.extra.social]]
icon = "fontawesome/brands/kaggle"
link = "https://www.kaggle.com/models/google/gemma-4"
name = "Gemma 4 on Kaggle"
# ============================================================================
# ANALYTICS & CONSENT
# ============================================================================
# Google Analytics 4 (GA4) Measurement ID. Can also be overridden at build time
# via the GA_MEASUREMENT_ID environment variable in scripts/build_docs.py.
[project.extra.analytics]
provider = "google"
property = "G-CWMC2KTTGQ"
[project.extra.consent]
title = "Cookie consent"
description = """
We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
"""
actions = ["accept", "reject", "manage"]
[project.extra.consent.cookies]
analytics = "Google Analytics"
# ============================================================================
# THEME
# ============================================================================
[project.theme]
logo = "assets/icon-one-color.png"
favicon = "assets/icon.png"
custom_dir = "overrides"
language = "en"
features = [
"announce.dismiss",
"content.code.annotate",
"content.code.copy",
"content.code.select",
"content.footnote.tooltips",
"content.tabs.link",
"content.tooltips",
"navigation.footer",
"navigation.instant",
"navigation.instant.prefetch",
"navigation.path",
"navigation.sections",
"navigation.tabs",
"navigation.tabs.sticky",
"navigation.top",
"navigation.tracking",
"search.highlight",
]
[project.theme.font]
text = "Inter"
code = "JetBrains Mono"
[[project.theme.palette]]
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"
[[project.theme.palette]]
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"
# ============================================================================
# MARKDOWN EXTENSIONS
# ============================================================================
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.magiclink]
[project.markdown_extensions.pymdownx.mark]
# Shared reference-link and glossary definitions, generated into snippets/ from
# data/links.yml and data/glossary.yml. links.md is appended to every page because a reference
# definition renders as nothing; glossary.md is opt-in per page, since `abbr` marks up every
# occurrence of a term and a global glossary would be noise.
[project.markdown_extensions.pymdownx.snippets]
base_path = ["snippets"]
auto_append = ["links.md"]
check_paths = true
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]