instructor

1
site_name: Instructor
2
site_author: Jason Liu
3
site_description: A lightweight library for structured outputs with LLMs. 
4
repo_name: instructor
5
repo_url: https://github.com/jxnl/instructor/
6
site_url: https://python.useinstructor.com/ 
7
edit_uri: edit/main/docs/
8
copyright: Copyright © 2024 Jason Liu 
9
theme:
10
  name: material
11
  icon:
12
    repo: fontawesome/brands/github
13
    edit: material/pencil 
14
    view: material/eye
15
    theme:
16
    admonition:
17
      note: octicons/tag-16
18
      abstract: octicons/checklist-16
19
      info: octicons/info-16
20
      tip: octicons/squirrel-16
21
      success: octicons/check-16
22
      question: octicons/question-16
23
      warning: octicons/alert-16
24
      failure: octicons/x-circle-16
25
      danger: octicons/zap-16
26
      bug: octicons/bug-16
27
      example: octicons/beaker-16
28
      quote: octicons/quote-16
29
  features:
30
    - announce.dismiss
31
    - content.action.edit
32
    - content.action.view
33
    - content.code.annotate
34
    - content.code.copy
35
    - content.code.select
36
    - content.tabs.link
37
    - content.tooltips
38
    - header.autohide
39
    - navigation.expand
40
    - navigation.footer
41
    - navigation.indexes
42
    - navigation.instant
43
    - navigation.instant.prefetch
44
    - navigation.instant.progress
45
    - navigation.prune
46
    - navigation.sections
47
    - navigation.tabs
48
    # - navigation.tabs.sticky
49
    - navigation.top
50
    - navigation.tracking
51
    - search.highlight
52
    - search.share
53
    - search.suggest
54
    - toc.follow
55
    # - toc.integrate
56
  palette:
57
      - scheme: default
58
        primary: black 
59
        accent: indigo
60
        toggle:
61
          icon: material/brightness-7
62
          name: Switch to dark mode
63
      - scheme: slate
64
        primary: black
65
        accent: indigo
66
        toggle:
67
          icon: material/brightness-4
68
          name: Switch to light mode
69
  font:
70
    text: Roboto
71
    code: Roboto Mono
72
  custom_dir: docs/overrides
73
# Extensions
74
markdown_extensions:
75
  - abbr
76
  - admonition
77
  - pymdownx.details
78
  - attr_list
79
  - def_list
80
  - footnotes
81
  - md_in_html
82
  - toc:
83
      permalink: true
84
  - pymdownx.arithmatex:
85
      generic: true
86
  - pymdownx.betterem:
87
      smart_enable: all
88
  - pymdownx.caret
89
  - pymdownx.details
90
  - pymdownx.emoji:
91
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
92
      emoji_index: !!python/name:material.extensions.emoji.twemoji
93
  - pymdownx.highlight:
94
      anchor_linenums: true
95
      line_spans: __span
96
      pygments_lang_class: true
97
  - pymdownx.inlinehilite
98
  - pymdownx.keys
99
  - pymdownx.magiclink:
100
      normalize_issue_symbols: true
101
      repo_url_shorthand: true
102
      user: jxnl 
103
      repo: instructor
104
  - pymdownx.mark
105
  - pymdownx.smartsymbols
106
  - pymdownx.snippets:
107
      auto_append:
108
        - includes/mkdocs.md
109
  - pymdownx.superfences:
110
      custom_fences:
111
        - name: mermaid
112
          class: mermaid
113
          format: !!python/name:pymdownx.superfences.fence_code_format
114
  - pymdownx.tabbed:
115
      alternate_style: true
116
      combine_header_slug: true
117
  - pymdownx.tasklist:
118
      custom_checkbox: true
119
nav:
120
  - Introduction: 
121
    - Welcome To Instructor: 'index.md'
122
    - Why use Instructor?: 'why.md'
123
    - Help with Instructor: 'help.md'
124
    - Installation: 'installation.md'
125
    - Contributing: 'contributing.md'
126
    - Philosophy: 'concepts/philosophy.md'
127
  - Cookbook:
128
    - Cookbooks: 'examples/index.md'
129
    - Text Classification: 'examples/classification.md'
130
    - Batch Classification (User Defined): 'examples/batch_classification.md'
131
    - LLM Self Critique: 'examples/self_critique.md'
132
    - Extracting Tables with GPT-V: 'examples/extracting_tables.md'
133
    - Extracting From Slides with GPT-V: 'examples/extract_slides.md'
134
    - Content Moderation: 'examples/moderation.md'
135
    - Citing Sources (RAG): 'examples/exact_citations.md'
136
    - Extracting Knowledge Graphs: 'examples/knowledge_graph.md'
137
    - Extracting Complex Entities: 'examples/entity_resolution.md'
138
    - Expanding Search Queries (RAG): 'examples/search.md'
139
    - Query Planning (RAG): 'examples/planning-tasks.md'
140
    - PII Data Sanitization: 'examples/pii.md'
141
    - Enabling Open Source Models: 'examples/open_source.md'
142
    - Image to Ad Copy: 'examples/image_to_ad_copy.md'
143
    - Ollama: 'examples/ollama.md'
144
    - SQLModel Integration: 'examples/sqlmodel.md'
145
    - Including Examples in Prompt: 'examples/examples.md'
146
    - Document Segmentation: 'examples/document_segmentation.md'
147
    - IBM watsonx.ai: 'examples/watsonx.md'
148
  - Blog:
149
    - "blog/index.md"
150
  - Concepts:
151
    - Models: 'concepts/models.md'
152
    - Fields: 'concepts/fields.md'
153
    - Types: 'concepts/types.md'
154
    - Validators: "concepts/reask_validation.md"
155
    - Usage Tokens: 'concepts/usage.md'
156
    - Missing: "concepts/maybe.md"
157
    - Patching: 'concepts/patching.md'
158
    - Retrying: 'concepts/retrying.md'
159
    - Parallel Tools: 'concepts/parallel.md'
160
    - Stream Iterable: "concepts/lists.md"
161
    - Stream Partial: "concepts/partial.md"
162
    - Raw Response: 'concepts/raw_response.md'
163
    - FastAPI: 'concepts/fastapi.md'
164
    - Caching: 'concepts/caching.md'
165
    - Logging: 'concepts/logging.md'
166
    - Distillation: "concepts/distillation.md"
167
    - Union: 'concepts/union.md'
168
    - Alias: 'concepts/alias.md'
169
    - Enums: 'concepts/enums.md'
170
    - Type Adapter: 'concepts/typeadapter.md'
171
  - Hub:
172
    - Introducing Instructor Hub: 'hub/index.md'
173
    - Single Classification Model: 'hub/single_classification.md'
174
    - Multiple Classification Model: 'hub/multiple_classification.md'
175
    - Extracting Tables using GPT-V: 'hub/tables_from_vision.md'
176
    - Extract Pandas Dataframes: 'hub/pandas_df.md'
177
    - Using Ollama: 'hub/ollama.md'
178
    - Using Llama CPP: 'hub/llama-cpp-python.md'
179
    - Using Together Compute: 'hub/together.md'
180
    - Using Anyscale: 'hub/anyscale.md'
181
    - Using Groq: 'hub/groq.md'
182
    - Using Mistral: 'hub/mistral.md'
183
    - Using Cohere: 'hub/cohere.md'
184
    - Batch Async Classification w/ Langsmith: 'hub/batch_classification_langsmith.md'
185
    - Action Items: 'hub/action_items.md'
186
    - Partial Streaming: 'hub/partial_streaming.md'
187
    - Extract Contact Info: 'hub/extract_contact_info.md'
188
    - Using Mistral Large: 'hub/mistral.md'
189
    - Knowledge Graphs: 'hub/knowledge_graph.md'
190
    - Extract Youtube Clips: "hub/youtube_clips.md"
191
    - Knowledge Graphs: 'tutorials/5-knowledge-graphs.ipynb'
192
  - CLI Reference:
193
      - "CLI Reference": "cli/index.md"
194
      - "Finetuning GPT-3.5": "cli/finetune.md"
195
      - "Usage Tracking": "cli/usage.md"
196
  - Tutorials:
197
    - Tutorials (Notebooks): 'tutorials/1-introduction.ipynb'
198
    - Tips and Tricks: 'tutorials/2-tips.ipynb'
199
    - Applications RAG: 'tutorials/3-0-applications-rag.ipynb'
200
    - Applications RAG - 2: 'tutorials/3-1-validation-rag.ipynb'
201
    - Validation: 'tutorials/4-validation.ipynb'
202
  
203
plugins:
204
  - mkdocs-jupyter:
205
      ignore_h1_titles: true
206
      execute: false
207
  - social
208
  - search:
209
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
210
  - minify:
211
      minify_html: true
212
  - mkdocstrings:
213
      handlers:
214
        python:
215
          options:
216
            members_order: alphabetical
217
            allow_inspection: true
218
            show_bases: true
219
  - blog:
220
      enabled: !ENV CI
221
      blog_dir: "blog"
222
      blog_toc: true
223
      post_dir: blog/posts
224
      post_date_format: yyyy/MM/dd
225
      post_url_format: "{date}/{slug}"
226
      authors_file: "{blog}/.authors.yml"
227
extra:
228
  analytics:
229
    provider: google
230
    property: G-5CR8QXF5CN
231
    feedback:
232
      title: Was this page helpful?
233
      ratings:
234
        - icon: material/emoticon-happy-outline
235
          name: This page was helpful
236
          data: 1
237
          note: >-
238
            Thanks for your feedback!
239
        - icon: material/emoticon-sad-outline
240
          name: This page could be improved
241
          data: 0
242
          note: >- 
243
            Thanks for your feedback! Help us improve this page by
244
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
245
  social:
246
    - icon: fontawesome/brands/twitter
247
      link: https://twitter.com/jxnlco
248
    - icon: fontawesome/brands/github
249
      link: https://github.com/jxnl
250