forked from truera/trulens
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
307 lines (290 loc) Β· 13.4 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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
site_name: π¦ TruLens
site_description: Evaluate and track LLM applications. Explain Deep Neural Nets.
repo_name: truera/trulens
repo_url: https://github.com/truera/trulens
markdown_extensions:
# Note: disabled most extensions are they were interfering with each other and
# rendering things poorly.
# https://squidfunk.github.io/mkdocs-material/reference/mathjax/
#- pymdownx.arithmatex:
# generic: true
- admonition
#- codehilite:
# guess_lang: true
#- footnotes
- toc:
permalink: true
#- pymdownx.arithmatex
#- pymdownx.betterem:
# smart_enable: all
#- pymdownx.caret
#- pymdownx.critic
# - pymdownx.details
# - pymdownx.extra
# - pymdownx.inlinehilite
- pymdownx.magiclink
# - pymdownx.mark
# - pymdownx.smartsymbols
- pymdownx.superfences
# - pymdownx.tasklist:
# custom_checkbox: true
#- pymdownx.tilde
#- mdx_math:
# enable_dollar_delimiter: True #for use of inline $..$
- markdown_include.include:
base_path: docs
- attr_list
watch:
- trulens_explain/trulens
- trulens_eval/trulens_eval
plugins:
- include-markdown:
preserve_includer_indent: false
dedent: false
trailing_newlines: true
comments: true
rewrite_relative_urls: true
heading_offset: 0
- search
- mkdocs-jupyter
- mkdocstrings:
# See https://mkdocstrings.github.io/python/usage/configuration/docstrings/ .
default_handler: python
handlers:
python:
import:
# These allow for links to types defined by various packages.
- https://docs.python.org/3/objects.inv
- https://docs.scipy.org/doc/numpy/objects.inv
- https://api.python.langchain.com/en/latest/objects.inv
- http://pandas.pydata.org/pandas-docs/stable/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
- https://typing-extensions.readthedocs.io/en/latest/objects.inv
- https://docs.llamaindex.ai/en/stable/objects.inv
- https://docs.sqlalchemy.org/en/20/objects.inv
options:
extensions:
- pydantic: { schema: true }
show_signature: true
show_signature_annotations: true
signature_crossrefs: true
separate_signature: true
line_length: 60
docstring_style: google
docstring_section_style: spacy
show_symbol_type_heading: true
show_symbol_type_toc: true
show_attributes: true
show_category_heading: true
show_submodules: false
group_by_category: true
show_source: false
show_root_heading: true
show_if_no_docstring: false
members_order: source
allow_inspection: true
# load_external_modules: true
#preload_modules:
#- __future__
#- builtins
#- datetime
#- pandas
# - numpy # some error occurs
#- pydantic
#- llama_index
#- typing
#- typing_extensions
# members:
filters:
- "!^_" # exlude all members starting with _
- "!^tru_class_info" # don't show tru_class_info
- "^__init__$" # but always include __init__ modules and methods
- "^__call__$" # and __call__ methods
paths:
- trulens_explain
- trulens_eval
#selection:
- redirects:
redirect_maps:
# These were distributed in the past but moved since then. Our own links
# in the docs are updated but we keep these here for any distributed
# links out there.
# NOTE: Even though both the source and target in these maps refer to
# ".md", the get interpreted (or maybe generated as) urls without ".md".
# hack: old .ipynb files are set has .md because .ipynb not supported for old link
trulens_eval/install.md: trulens_eval/getting_started/install.md
trulens_eval/core_concepts_feedback_functions.md: trulens_eval/getting_started/core_concepts/feedback_functions.md
trulens_eval/core_concepts_rag_triad.md: trulens_eval/getting_started/core_concepts/rag_triad.md
trulens_eval/core_concepts_honest_harmless_helpful_evals.md: trulens_eval/getting_started/core_concepts/honest_harmless_helpful_evals.md
trulens_eval/quickstart.md: trulens_eval/getting_started/quickstarts/quickstart.ipynb
trulens_eval/langchain_quickstart.md: trulens_eval/getting_started/quickstarts/langchain_quickstart.ipynb
trulens_eval/llama_index_quickstart.md: trulens_eval/getting_started/quickstarts/llama_index_quickstart.ipynb
trulens_eval/text2text_quickstart.md: trulens_eval/getting_started/quickstarts/text2text_quickstart.ipynb
trulens_eval/groundtruth_evals.md: trulens_eval/getting_started/quickstarts/groundtruth_evals.ipynb
trulens_eval/human_feedback.md: trulens_eval/getting_started/quickstarts/human_feedback.ipynb
theme:
name: material
icon:
repo: fontawesome/brands/github
custom_dir: docs/overrides/
palette:
scheme: trulens
#font:
# text: Source Sans Pro
favicon: img/favicon.ico
logo: img/squid.png
features:
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
# - navigation.instant
# - navigation.instant.progress
- navigation.indexes
- navigation.top
- navigation.tabs
- navigation.sections
# - navigation.expand
- navigation.tracking
- navigation.path
- search.share
- search.suggest
- toc.follow
# - toc.integrate
- content.code.copy
nav:
- π Home: index.md
# - π Home: docs.md
- π Getting Started:
- trulens_eval/getting_started/index.md
- π¨ Installation: trulens_eval/getting_started/install.md
- π Quickstarts:
# - trulens_eval/getting_started/quickstarts/index.md
# Title labels of these notebooks come from within the notebooks
# themselves and will be overridden if specified here.
- trulens_eval/getting_started/quickstarts/quickstart.ipynb
- trulens_eval/getting_started/quickstarts/existing_data_quickstart.ipynb
- trulens_eval/getting_started/quickstarts/langchain_quickstart.ipynb
- trulens_eval/getting_started/quickstarts/llama_index_quickstart.ipynb
- trulens_eval/getting_started/quickstarts/text2text_quickstart.ipynb
- trulens_eval/getting_started/quickstarts/groundtruth_evals.ipynb
- trulens_eval/getting_started/quickstarts/human_feedback.ipynb
- β Core Concepts:
- trulens_eval/getting_started/core_concepts/index.md
- β Feedback Functions: trulens_eval/getting_started/core_concepts/feedback_functions.md
- β RAG Triad: trulens_eval/getting_started/core_concepts/rag_triad.md
- π Honest, Harmless, Helpful Evals: trulens_eval/getting_started/core_concepts/honest_harmless_helpful_evals.md
- π― Evaluation:
# PLACEHOLDER: - trulens_eval/evaluation/index.md
- β Feedback Functions:
- trulens_eval/evaluation/feedback_functions/index.md
- 𦴠Anatomy of a Feedback Function: trulens_eval/evaluation/feedback_functions/anatomy.md
- Feedback Implementations:
- trulens_eval/evaluation/feedback_implementations/index.md
- π§° Stock Feedback Functions: trulens_eval/evaluation/feedback_implementations/stock.md
- trulens_eval/evaluation/feedback_implementations/custom_feedback_functions.ipynb
- Feedback Selectors:
- trulens_eval/evaluation/feedback_selectors/index.md
- Selecting Components: trulens_eval/evaluation/feedback_selectors/selecting_components.md
- Selector Shortcuts: trulens_eval/evaluation/feedback_selectors/selector_shortcuts.md
- Feedback Aggregation:
- trulens_eval/evaluation/feedback_aggregation/index.md
- Running Feedback Functions:
# PLACEHOLDER: - trulens_eval/evaluation/running_feedback_functions/index.md
- Running with your app: trulens_eval/evaluation/running_feedback_functions/with_app.md
- Running on existing data: trulens_eval/evaluation/running_feedback_functions/existing_data.md
- Generating Test Cases:
- trulens_eval/evaluation/generate_test_cases/index.md
- Feedback Evaluations:
# PLACEHOLDER: - trulens_eval/evaluation/feedback_evaluations/index.md
- Answer Relevance Benchmark (small): trulens_eval/evaluation/feedback_evaluations/answer_relevance_benchmark_small.ipynb
- Comprehensiveness Benchmark: trulens_eval/evaluation/feedback_evaluations/comprehensiveness_benchmark.ipynb
- Context Relevance Benchmark (small): trulens_eval/evaluation/feedback_evaluations/context_relevance_benchmark_small.ipynb
- Context Relevance Benchmark (large): trulens_eval/evaluation/feedback_evaluations/context_relevance_benchmark.ipynb
- Groundedness Benchmark: trulens_eval/evaluation/feedback_evaluations/groundedness_benchmark.ipynb
- πΊ Tracking:
# PLACEHOLDER: - trulens_eval/tracking/index.md
- Instrumentation Overview:
- trulens_eval/tracking/instrumentation/index.ipynb
# Titles set inside notebooks and will be overridden if provider here.
- trulens_eval/tracking/instrumentation/langchain.ipynb
- trulens_eval/tracking/instrumentation/llama_index.ipynb
- trulens_eval/tracking/instrumentation/nemo.ipynb
- Logging:
# PLACEHOLDER: - trulens_eval/tracking/logging/index.md
- Where to Log: trulens_eval/tracking/logging/where_to_log.md
- π Logging Methods: trulens_eval/tracking/logging/logging.ipynb
- π Guides:
# PLACEHOLDER: - trulens_eval/guides/index.md
- Any LLM App: trulens_eval/guides/use_cases_any.md
- RAGs: trulens_eval/guides/use_cases_rag.md
- LLM Agents: trulens_eval/guides/use_cases_agent.md
- Dev to Prod: trulens_eval/guides/use_cases_production.md
- β API Reference:
# PLACEHOLDER: - trulens_eval/api/index.md
- π¦ Tru: trulens_eval/api/tru.md
- App:
- trulens_eval/api/app/index.md
- TruBasicApp: trulens_eval/api/app/trubasicapp.md
- π¦οΈπ TruChain: trulens_eval/api/app/truchain.md
- π¦ TruLlama: trulens_eval/api/app/trullama.md
- TruRails: trulens_eval/api/app/trurails.md
- TruCustom: trulens_eval/api/app/trucustom.md
- β¬ TruVirtual: trulens_eval/api/app/truvirtual.md
- Feedback: trulens_eval/api/feedback.md
- πΎ Record: trulens_eval/api/record.md
- Provider:
- trulens_eval/api/provider/index.md
- LLMProvider: trulens_eval/api/provider/llmprovider.md
- OpenAI:
- trulens_eval/api/provider/openai/index.md
- AzureOpenAI: trulens_eval/api/provider/openai/azureopenai.md
- AWS Bedrock: trulens_eval/api/provider/bedrock.md
- LiteLLM: trulens_eval/api/provider/litellm.md
- π¦οΈπ LangChain: trulens_eval/api/provider/langchain.md
- π€ HuggingFace: trulens_eval/api/provider/huggingface.md
- Endpoint:
- trulens_eval/api/endpoint/index.md
- OpenAI: trulens_eval/api/endpoint/openai.md
- π’ Instruments: trulens_eval/api/instruments.md
- π Database:
- trulens_eval/api/database/index.md
- β¨ Migration: trulens_eval/api/database/migration.md
- π§ͺ SQLAlchemy: trulens_eval/api/database/sqlalchemy.md
- Utils:
# - trulens_eval/api/utils/index.md
- trulens_eval/api/utils/python.md
- trulens_eval/api/utils/serial.md
- trulens_eval/api/utils/json.md
- trulens_eval/api/utils/frameworks.md
- trulens_eval/api/utils/utils.md
- π€ Contributing:
- trulens_eval/contributing/index.md
- π§ Design: trulens_eval/contributing/design.md
- β
Standards: trulens_eval/contributing/standards.md
- π£ Tech Debt: trulens_eval/contributing/techdebt.md
- β¨ Database Migration: trulens_eval/contributing/migration.md
- β Explain:
# PLACEHOLDER: - trulens_explain/index.md
- Getting Started:
# PLACEHOLDER: - trulens_explain/getting_started/index.md
- Installation: trulens_explain/getting_started/install.md
- Quickstart: trulens_explain/getting_started/quickstart.md
- Attributions: trulens_explain/attribution_parameterization.md
- β API Reference:
# PLACEHOLDER: - trulens_explain/api/index.md
- Attribution: trulens_explain/api/attribution.md
- Models: trulens_explain/api/model_wrappers.md
- Slices: trulens_explain/api/slices.md
- Quantities: trulens_explain/api/quantities.md
- Distributions: trulens_explain/api/distributions.md
- Visualizations: trulens_explain/api/visualizations.md
# - Resources:
# - NeurIPS Demo: https://truera.github.io/neurips-demo-2021/
extra_css:
- stylesheets/extra.css
# https://squidfunk.github.io/mkdocs-material/reference/mathjax/
# Polyfill provides backcompat for JS. We need to import it before
# importing MathJax.
extra_javascript:
- javascript/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- javascript/tex-mml-chtml-3.0.0.js
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML