forked from dottxt-ai/outlines
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
149 lines (138 loc) · 3.85 KB
/
mkdocs.yml
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
# Site information
site_name: Outlines 〰️
site_author: The Outlines developers
site_description: >-
Structured text generation with LLMs
# Repository
repo_name: outlines-dev/outlines
repo_url: https://github.com/outlines-dev/outlines
# Copyright
copyright: Copyright © 2023- The Outlines Developers
# Configuration
theme:
name: material
custom_dir: docs/overrides
palette:
- scheme: default
primary: white
logo: assets/images/logo.png
favicon: assets/images/logo.png
icon:
repo: fontawesome/brands/github
features:
- content.code.copy
- navigation.expand
- navigation.tabs
- navigation.sections
- header.autohide
- announce.dismiss
font:
text: Inter
code: Source Code Pro
# Additional configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/outlines-dev
- icon: fontawesome/brands/twitter
link: https://twitter.com/remilouf
generator: false
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
# Extensions
markdown_extensions:
- admonition
- def_list
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
noclasses: True
pygments_style: bw
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
- stylesheets/extra.css
plugins:
- blog
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_submodules: true
- search
- section-index
- social:
cards_layout_options:
color: #173a58
nav:
- Home: index.md
- Getting Started:
- Welcome to Outlines: welcome.md
- Installation: installation.md
- Quickstart: quickstart.md
- Licence: licence.md
- Cookbook:
- cookbook/index.md
- Classification: cookbook/classification.md
- Named Entity Extraction: cookbook/extraction.md
- Generate synthetic data: cookbook/dating_profiles.md
- Summarize a document: cookbook/chain_of_density.md
- Playing chess: cookbook/models_playing_chess.md
- Docs:
- reference/index.md
- Text generation:
- Free text: reference/text.md
- Classification: reference/choices.md
- JSON: reference/json.md
- Grammar: reference/cfg.md
- Regex: reference/regex.md
- Types: reference/types.md
- Samplers: reference/samplers.md
- Custom FSM operations: reference/custom_fsm_ops.md
- Utilities:
- Serve with vLLM: reference/vllm.md
- Prompt templating: reference/prompting.md
- Outlines functions: reference/functions.md
- Models:
- OpenAI: reference/models/openai.md
- Llama.cpp: reference/models/llamacpp.md
- API Reference:
- api/index.md
- api/models.md
- api/prompts.md
- api/json_schema.md
- api/fsm.md
- api/parsing.md
- api/regex.md
- api/samplers.md
- Community:
- community/index.md
- Feedback 🫶: community/feedback.md
- Chat with us ☕: https://discord.com/invite/R9DSu34mGd
- How to contribute 🏗️: community/contribute.md
- Blog: blog/index.md