forked from guardrails-ai/guardrails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
185 lines (172 loc) · 6.21 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
site_name: Guardrails AI
site_url: https://docs.guardrailsai.com
site_author: Shreya Rajpal
repo_url: https://github.com/ShreyaR/guardrails
repo_name: ShreyaR/guardrails
remote_branch: gh-pages
remote_name: origin
copyright: |
Maintained by <a href="https://github.com/shreyar">Shreya Rajpal</a>.
nav:
- 'Introduction': guardrails_ai/introduction.md
- 'Getting Started': guardrails_ai/getting_started.ipynb
- 'Installation': guardrails_ai/installation.md
- 'Migrating to 0.2.x': 0-2-migration.md
- 'FAQ': faq.md
- 'Defining Guardrails':
- 'Pydantic': defining_guards/pydantic.ipynb
- 'Strings': defining_guards/strings.ipynb
- 'RailSpec': defining_guards/rail.md
- 'Concepts':
- 'Guard': concepts/guard.md
- 'Validators': concepts/validators.md
- 'Output Element': concepts/output.md
- 'Prompt Element': concepts/prompt.md
- 'Instruction Element': concepts/instructions.md
- 'Logs': concepts/logs.md
- 'API Reference':
- 'Guard': api_reference/guard.md
- 'Rail': api_reference/rail.md
- 'Validators': api_reference/validators.md
- 'Response Structures': api_reference/response_structures.md
- 'Schema': api_reference/schema.md
- 'Document Store': api_reference/document_store.md
- 'Data Types': api_reference/data_types.md
- 'CLI Reference': cli.md
# - 'Recipes':
# - 'Generating structured data': recipes/generate_structured_data.ipynb
# - 'Validating structured data': recipes/validate_structured_data.ipynb
- 'Examples':
- 'Text to SQL': use_cases/text2sql/text2sql.ipynb
- 'Use Guardrails with Chat Models': examples/guardrails_with_chat_models.ipynb
- 'If condition: generate different JSON objects based on condition': examples/select_choice_based_on_action.ipynb
- 'Extracting entities from ToS': examples/extracting_entities.ipynb
- 'Generating bug-free Python code': examples/bug_free_python_code.ipynb
- 'No secrets in generated text': examples/no_secrets_in_generated_text.ipynb
- 'Natural language to bug-free SQL': examples/syntax_error_free_sql.ipynb
- 'Vegan Mac & Cheese Recipe Generator': examples/recipe_generation.ipynb
- 'Using GPT to play valid chess moves': examples/valid_chess_moves.ipynb
- 'Translate text with profanity filtering': examples/translation_to_specific_language.ipynb
- 'Generate structured synthetic data': examples/generate_structured_data.ipynb
- 'Ensure translated text is high quality': examples/translation_with_quality_check.ipynb
- 'Check key info present in generated summary': examples/text_summarization_quality.ipynb
- 'Detect and limit hallucinations in generated text': examples/provenance.ipynb
- 'Integrations':
- 'OpenAI Functions': integrations/openai_functions.ipynb
- 'LangChain': integrations/langchain.ipynb
- 'Join the Guardrails AI team': https://equatorial-bergamot-e37.notion.site/Join-the-Guardrails-AI-team-fd2fbf54f7834ba1b4c4d985162d34e1?pvs=4
theme:
name: material
favicon: img/favicon.ico
logo: img/guardrails_logo.png
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
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:
- navigation.instant
- navigation.tracking
- navigation.expand
# - navigation.sections
- content.code.annotate
- toc.follow
palette:
- scheme: default
primary: black
toggle:
icon: material/toggle-switch
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: black
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
- tables
- def_list
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- social
- search
- glightbox
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
show_source: false
show_bases: false
show_if_no_docstring: true
merge_init_into_class: true
show_root_toc_entry: false
show_inheritance: true # This is no longer a valid option
inherited_members: true # This might be the replacement?
# The below are now filters in the MD file
# https://mkdocstrings.github.io/python/usage/configuration/members/#filters
show_private: false # This is no longer a valid option
show_special_members: false # This is no longer a valid option
# Newly added options
annotations_path: brief
show_signature_annotations: true
separate_signature: true
signature_crossrefs: true
- mknotebooks:
execute: false
timeout: 100
allow_errors: false
tag_remove_configs:
remove_cell_tags:
- Remove_cell
remove_all_outputs_tags:
- Remove_all_output
remove_single_output_tags:
- Remove_single_output
remove_input_tags:
- Remove_input
# - mkdocs-jupyter:
# execute_notebooks: true
# kernel_name: python3
# extra_arguments:
# - "--InlineBackend.figure_format=svg"
# include_source: True
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/guardrails_ai
- icon: fontawesome/brands/github
link: https://github.com/ShreyaR/guardrails
- icon: fontawesome/brands/discord
link: https://discord.gg/Jsey3mX98B