outlines

1
# Site information
2
site_name: Outlines 〰️
3
site_author: The Outlines developers
4
site_description: >-
5
  Structured text generation with LLMs
6

7

8
# Repository
9
repo_name: outlines-dev/outlines
10
repo_url: https://github.com/outlines-dev/outlines
11

12
# Copyright
13
copyright: Copyright © 2023- The Outlines Developers
14

15
# Configuration
16
theme:
17
  name: material
18
  custom_dir: docs/overrides
19
  palette:
20
    - scheme: default
21
      primary: white
22
  logo: assets/images/logo.png
23
  favicon: assets/images/logo.png
24
  icon:
25
    repo: fontawesome/brands/github
26
  features:
27
    - content.code.copy
28
    - navigation.expand
29
    - navigation.tabs
30
    - navigation.sections
31
    - header.autohide
32
    - announce.dismiss
33
  font:
34
    text: Inter
35
    code: Source Code Pro
36

37
# Additional configuration
38
extra:
39
  social:
40
    - icon: fontawesome/brands/github
41
      link: https://github.com/outlines-dev
42
    - icon: fontawesome/brands/twitter
43
      link: https://twitter.com/remilouf
44
  generator: false
45
  analytics:
46
    provider: google
47
    property: !ENV GOOGLE_ANALYTICS_KEY
48

49
# Extensions
50
markdown_extensions:
51
  - admonition
52
  - def_list
53
  - attr_list
54
  - md_in_html
55
  - pymdownx.highlight:
56
      anchor_linenums: true
57
      line_spans: __span
58
      pygments_lang_class: true
59
      noclasses: True
60
      pygments_style: nord
61
  - pymdownx.superfences
62
  - pymdownx.tabbed:
63
      alternate_style: true
64
  - pymdownx.inlinehilite
65
  - pymdownx.details
66
  - pymdownx.emoji:
67
      emoji_index: !!python/name:material.extensions.emoji.twemoji
68
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
69

70

71
extra_css:
72
  - stylesheets/extra.css
73

74
plugins:
75
  - blog
76
  - mkdocstrings:
77
      default_handler: python
78
      handlers:
79
        python:
80
          options:
81
            show_submodules: true
82
  - search
83
  - section-index
84
  - social:
85
      cards_layout_options:
86
        color: #173a58
87

88
nav:
89
  - Home: index.md
90
  - Getting Started:
91
      - Welcome to Outlines: welcome.md
92
      - Installation: installation.md
93
      - Quickstart: quickstart.md
94
      - Licence: licence.md
95
  - Cookbook:
96
      - cookbook/index.md
97
      - Classification: cookbook/classification.md
98
      - Named Entity Extraction: cookbook/extraction.md
99
      - Generate synthetic data: cookbook/dating_profiles.md
100
      - Summarize a document: cookbook/chain_of_density.md
101
      - Playing chess: cookbook/models_playing_chess.md
102
      - Run on the cloud:
103
          - BentoML: cookbook/deploy-using-bentoml.md
104
          - Modal: cookbook/deploy-using-modal.md
105
  - Docs:
106
    - reference/index.md
107
    - Generation:
108
        - Text: reference/text.md
109
        - Samplers: reference/samplers.md
110
    - Structured generation:
111
        - Classification: reference/choices.md
112
        - Regex: reference/regex.md
113
        - Type constraints: reference/format.md
114
        - JSON (function calling): reference/json.md
115
        - JSON mode: reference/json_mode.md
116
        - Grammar: reference/cfg.md
117
        - Custom FSM operations: reference/custom_fsm_ops.md
118
    - Utilities:
119
        - Serve with vLLM: reference/serve/vllm.md
120
        - Custom types: reference/types.md
121
        - Prompt templating: reference/prompting.md
122
        - Outlines functions: reference/functions.md
123
    - Models:
124
        - vLLM: reference/models/vllm.md
125
        - Llama.cpp: reference/models/llamacpp.md
126
        - Transformers: reference/models/transformers.md
127
        - ExllamaV2: reference/models/exllamav2.md
128
        - Mamba: reference/models/mamba.md
129
        - OpenAI: reference/models/openai.md
130

131
  - API Reference:
132
    - api/index.md
133
    - api/models.md
134
    - api/prompts.md
135
    - api/json_schema.md
136
    - api/guide.md
137
    - api/parsing.md
138
    - api/regex.md
139
    - api/samplers.md
140
  - Community:
141
    - community/index.md
142
    - Feedback 🫶: community/feedback.md
143
    - Chat with us ☕: https://discord.com/invite/R9DSu34mGd
144
    - How to contribute 🏗️: community/contribute.md
145
    - Your projects 👏: community/examples.md
146
  - Blog: blog/index.md
147