-
Notifications
You must be signed in to change notification settings - Fork 5
/
mkdocs.yml
131 lines (131 loc) · 4.02 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
site_name: ragbits docs
site_description: Library for fast RAG application development
site_url: https://ragbits.deepsense.ai
repo_name: deepsense-ai/ragbits
repo_url: https://github.com/deepsense-ai/ragbits
copyright: Copyright © 2024 deepsense.ai
nav:
- rabgbits: index.md
- Quick Start:
- quickstart/quickstart1_prompts.md
- quickstart/quickstart2_rag.md
- How-to Guides:
- how-to/use_prompting.md
- how-to/prompts_lab.md
- how-to/use_guardrails.md
- how-to/integrations/promptfoo.md
- Document Search:
- how-to/document_search/async_processing.md
- how-to/document_search/create_custom_execution_strategy.md
- how-to/document_search/search_documents.md
- how-to/document_search/use_rephraser.md
- how-to/document_search/use_reranker.md
- how-to/document_search/distributed_ingestion.md
- Evaluate:
- how-to/evaluate/optimize.md
- how-to/evaluate/generate_dataset.md
- how-to/evaluate/evaluate.md
- how-to/evaluate/custom_metric.md
- how-to/evaluate/custom_evaluation_pipeline.md
- how-to/evaluate/custom_metric.md
- how-to/evaluate/custom_dataloader.md
- API Reference:
- Core:
- api_reference/core/prompt.md
- api_reference/core/llms.md
- api_reference/core/embeddings.md
- api_reference/core/vector-stores.md
- Document Search:
- api_reference/document_search/index.md
- api_reference/document_search/documents.md
- Ingestion:
- api_reference/document_search/processing.md
- api_reference/document_search/execution_strategies.md
theme:
name: material
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/lightbulb-auto
name: Switch to light mode
- media: '(prefers-color-scheme: light)'
scheme: default
primary: primary
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: primary
toggle:
icon: material/lightbulb-outline
name: Switch to system preference
features:
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- content.code.annotate
- content.code.copy
extra_css:
- stylesheets/extra.css
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- admonition
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.inlinehilite
- attr_list
- md_in_html
- pymdownx.details
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
options:
show_root_heading: true
show_if_no_docstring: true
inherited_members: true
members_order: source
separate_signature: true
unwrap_annotated: true
filters:
- "!^_"
merge_init_into_class: true
docstring_section_style: spacy
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_signature_annotations: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/deepsense-ai
- icon: fontawesome/brands/x-twitter
link: https://x.com/deepsense_ai
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/deepsense-ai
- icon: fontawesome/brands/youtube
link: https://youtube.com/@deepsenseai
- icon: fontawesome/brands/medium
link: https://medium.com/deepsense-ai
- icon: fontawesome/solid/globe
link: https://deepsense.ai