superpipe/mkdocs.yml at main · villagecomputing/superpipe · GitHub

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
site_name: Superpipe
site_author: Aman Dhesi, Ben Scharfstein
site_description: LLM pipelines for structured data extraction and classification
repo_name: superpipe
repo_url: https://github.com/villagecomputing/superpipe
site_url: https://docs.superpipe.ai

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/superpipe.png
  features:
    - navigation.sections
    - navigation.tracking
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - search.suggest
    - search.highlight
    - navigation.tabs
    - navigation.tabs.sticky
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Introduction:
      - index.md
      - build.md
      - evaluate.md
      - optimize.md
      - why.md
      - use_cases.md
      - workflow.md
      - principles.md
      - roadmap.md
  - Concepts:
      - concepts/index.md
      - Steps:
          - concepts/steps/index.md
          - concepts/steps/LLMStep.md
          - concepts/steps/LLMStructuredStep.md
          - concepts/steps/SERPStep.md
          - concepts/steps/EmbeddingSearchStep.md
          - concepts/steps/CustomStep.md
      - Pipelines: concepts/pipelines.md
      - Models: concepts/models.md
      - Grid Search: concepts/grid_search.md
  - Examples:
      - examples/index.md
      - examples/web_scraping/web_scraping.ipynb
      - examples/product_categorization/product_categorization.ipynb
      - examples/business_classification/business_classification.ipynb
      - examples/comparing_pipelines/furniture.ipynb
      - examples/custom_eval/jokes.ipynb

  - Studio:
      - studio/index.md

  - Work with us:
      - consulting.md

  - Blog:
      - blog/index.md

markdown_extensions:
  - admonition
  - 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: villagecomputing
      repo: superpipe
  - 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
  - tables
  - toc:
      permalink: true

plugins:
  - mkdocs-jupyter:
      include_source: True
  - search
  - social:
      cards_layout: default
  - blog

social:
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/villagecompute
  - icon: fontawesome/brands/github
    link: https://github.com/villagecomputing

extra:
  analytics:
    provider: google
    property: G-004PC5QJ4H