/
mkdocs.yml
249 lines (248 loc) · 7.94 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
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
site_name: Instructor
site_author: Jason Liu
site_description: A lightweight library for structured outputs with LLMs.
repo_name: instructor
repo_url: https://github.com/jxnl/instructor/
site_url: https://python.useinstructor.com/
edit_uri: edit/main/docs/
copyright: Copyright © 2024 Jason Liu
theme:
name: material
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
theme:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- scheme: default
primary: black
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: black
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
custom_dir: docs/overrides
# Extensions
markdown_extensions:
- abbr
- admonition
- pymdownx.details
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: jxnl
repo: instructor
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
auto_append:
- includes/mkdocs.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
- pymdownx.tasklist:
custom_checkbox: true
nav:
- Introduction:
- Welcome To Instructor: 'index.md'
- Why use Instructor?: 'why.md'
- Help with Instructor: 'help.md'
- Installation: 'installation.md'
- Contributing: 'contributing.md'
- Philosophy: 'concepts/philosophy.md'
- Cookbook:
- Cookbooks: 'examples/index.md'
- Text Classification: 'examples/classification.md'
- Batch Classification (User Defined): 'examples/batch_classification.md'
- LLM Self Critique: 'examples/self_critique.md'
- Extracting Tables with GPT-V: 'examples/extracting_tables.md'
- Extracting From Slides with GPT-V: 'examples/extract_slides.md'
- Content Moderation: 'examples/moderation.md'
- Citing Sources (RAG): 'examples/exact_citations.md'
- Extracting Knowledge Graphs: 'examples/knowledge_graph.md'
- Extracting Complex Entities: 'examples/entity_resolution.md'
- Expanding Search Queries (RAG): 'examples/search.md'
- Query Planning (RAG): 'examples/planning-tasks.md'
- PII Data Sanitization: 'examples/pii.md'
- Enabling Open Source Models: 'examples/open_source.md'
- Image to Ad Copy: 'examples/image_to_ad_copy.md'
- Ollama: 'examples/ollama.md'
- SQLModel Integration: 'examples/sqlmodel.md'
- Including Examples in Prompt: 'examples/examples.md'
- Document Segmentation: 'examples/document_segmentation.md'
- IBM watsonx.ai: 'examples/watsonx.md'
- Blog:
- "blog/index.md"
- Concepts:
- Models: 'concepts/models.md'
- Fields: 'concepts/fields.md'
- Types: 'concepts/types.md'
- Validators: "concepts/reask_validation.md"
- Usage Tokens: 'concepts/usage.md'
- Missing: "concepts/maybe.md"
- Patching: 'concepts/patching.md'
- Retrying: 'concepts/retrying.md'
- Parallel Tools: 'concepts/parallel.md'
- Stream Iterable: "concepts/lists.md"
- Stream Partial: "concepts/partial.md"
- Raw Response: 'concepts/raw_response.md'
- FastAPI: 'concepts/fastapi.md'
- Caching: 'concepts/caching.md'
- Logging: 'concepts/logging.md'
- Distillation: "concepts/distillation.md"
- Union: 'concepts/union.md'
- Alias: 'concepts/alias.md'
- Enums: 'concepts/enums.md'
- Type Adapter: 'concepts/typeadapter.md'
- Hub:
- Introducing Instructor Hub: 'hub/index.md'
- Single Classification Model: 'hub/single_classification.md'
- Multiple Classification Model: 'hub/multiple_classification.md'
- Extracting Tables using GPT-V: 'hub/tables_from_vision.md'
- Extract Pandas Dataframes: 'hub/pandas_df.md'
- Using Ollama: 'hub/ollama.md'
- Using Llama CPP: 'hub/llama-cpp-python.md'
- Using Together Compute: 'hub/together.md'
- Using Anyscale: 'hub/anyscale.md'
- Using Groq: 'hub/groq.md'
- Using Mistral: 'hub/mistral.md'
- Using Cohere: 'hub/cohere.md'
- Batch Async Classification w/ Langsmith: 'hub/batch_classification_langsmith.md'
- Action Items: 'hub/action_items.md'
- Partial Streaming: 'hub/partial_streaming.md'
- Extract Contact Info: 'hub/extract_contact_info.md'
- Using Mistral Large: 'hub/mistral.md'
- Knowledge Graphs: 'hub/knowledge_graph.md'
- Extract Youtube Clips: "hub/youtube_clips.md"
- Knowledge Graphs: 'tutorials/5-knowledge-graphs.ipynb'
- CLI Reference:
- "CLI Reference": "cli/index.md"
- "Finetuning GPT-3.5": "cli/finetune.md"
- "Usage Tracking": "cli/usage.md"
- Tutorials:
- Tutorials (Notebooks): 'tutorials/1-introduction.ipynb'
- Tips and Tricks: 'tutorials/2-tips.ipynb'
- Applications RAG: 'tutorials/3-0-applications-rag.ipynb'
- Applications RAG - 2: 'tutorials/3-1-validation-rag.ipynb'
- Validation: 'tutorials/4-validation.ipynb'
plugins:
- mkdocs-jupyter:
ignore_h1_titles: true
execute: false
- social
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- mkdocstrings:
handlers:
python:
options:
members_order: alphabetical
allow_inspection: true
show_bases: true
- blog:
enabled: !ENV CI
blog_dir: "blog"
blog_toc: true
post_dir: blog/posts
post_date_format: yyyy/MM/dd
post_url_format: "{date}/{slug}"
authors_file: "{blog}/.authors.yml"
extra:
analytics:
provider: google
property: G-5CR8QXF5CN
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-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>.
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/jxnlco
- icon: fontawesome/brands/github
link: https://github.com/jxnl