| site_name: Speculators Docs |
| site_description: A unified library for building, and storing speculative decoding algorithms for large language model (LLM) inference |
| site_url: https://vllm-project.github.io/speculators |
| repo_url: https://github.com/vllm-project/speculators |
| edit_uri: https://github.com/vllm-project/speculators/tree/main/docs |
|
|
| theme: |
| name: material |
| font: |
| text: Roboto |
| code: Roboto Mono |
| language: en |
| logo: assets/branding/speculators-icon-white.png |
| favicon: assets/branding/speculators-icon-black.png |
| features: |
| - content.action.edit |
| - content.code.annotate |
| - content.code.copy |
| - content.code.select |
| - content.tabs.link |
| - navigation.footer |
| - navigation.indexes |
| - navigation.instant |
| - navigation.path |
| - navigation.sections |
| - navigation.tabs |
| - navigation.tabs.sticky |
| - navigation.top |
| - navigation.tracking |
| - search.highlight |
| - search.share |
| - search.suggest |
| - toc.follow |
| palette: |
| |
| - media: "(prefers-color-scheme)" |
| toggle: |
| icon: material/brightness-auto |
| name: Switch to light mode |
|
|
| |
| - media: "(prefers-color-scheme: light)" |
| scheme: youtube |
| toggle: |
| icon: material/brightness-7 |
| name: Switch to dark mode |
|
|
| |
| - media: "(prefers-color-scheme: dark)" |
| scheme: slate |
| toggle: |
| icon: material/brightness-4 |
| name: Switch to system preference |
|
|
| validation: |
| links: |
| absolute_links: relative_to_docs |
| anchors: warn |
| unrecognized_links: warn |
|
|
| markdown_extensions: |
| - abbr |
| - admonition |
| - attr_list |
| - def_list |
| - footnotes |
| - md_in_html |
| - pymdownx.arithmatex: |
| generic: true |
| - pymdownx.blocks.caption |
| |
| |
| |
| - pymdownx.blocks.tab: |
| alternate_style: true |
| - pymdownx.details |
| - pymdownx.magiclink |
| - pymdownx.emoji: |
| emoji_index: !!python/name:material.extensions.emoji.twemoji |
| emoji_generator: !!python/name:material.extensions.emoji.to_svg |
| - pymdownx.highlight: |
| anchor_linenums: true |
| line_spans: __span |
| pygments_lang_class: true |
| - pymdownx.inlinehilite |
| - pymdownx.mark |
| - pymdownx.smartsymbols |
| - pymdownx.snippets |
| - pymdownx.superfences: |
| custom_fences: |
| - name: mermaid |
| class: mermaid |
| format: !!python/name:pymdownx.superfences.fence_code_format |
| - pymdownx.tabbed: |
| alternate_style: true |
| - pymdownx.tasklist: |
| custom_checkbox: true |
| - pymdownx.tilde |
| - tables |
|
|
| plugins: |
| - api-autonav: |
| modules: ['src/speculators'] |
| - awesome-nav |
| - mike |
| - minify: |
| minify_html: true |
| - mkdocs-nav-weight |
| - mkdocstrings: |
| default_handler: python |
| handlers: |
| python: |
| options: |
| docstring_section_style: list |
| docstring_style: sphinx |
| filters: ["!^_"] |
| heading_level: 1 |
| merge_init_into_class: true |
| parameter_headings: true |
| separate_signature: true |
| show_root_heading: true |
| show_signature_annotations: true |
| show_symbol_type_heading: true |
| show_symbol_type_toc: true |
| summary: true |
| - redirects: |
| redirect_maps: |
| user_guide/tutorials/train_eagle3_online.md: user_guide/tutorials/train.md |
| user_guide/tutorials/train_eagle3_offline.md: user_guide/tutorials/train.md |
| user_guide/tutorials/train_dflash_online.md: user_guide/tutorials/train.md |
| user_guide/tutorials/train_peagle_offline.md: user_guide/tutorials/train.md |
| user_guide/tutorials/train_mtp_online.md: user_guide/tutorials/train.md |
| - search |
| - section-index |
| - social |
| - tags |
|
|
| extra: |
| generator: false |
| version: |
| provider: mike |
| alias: true |
| default: |
| - stable |
| - development |
|
|
| extra_css: |
| - stylesheets/style.css |
|
|
| extra_javascript: |
| - scripts/mathjax.js |
| - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js |
|
|
