-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathmkdocs.yml
263 lines (253 loc) · 9.88 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
site_name: Testing with Kolena
site_description: Python client for Kolena's machine learning testing platform
site_url: https://docs.kolena.com
strict: true
copyright: Copyright © 2021-2025 Kolena
nav:
- Developer Guide:
- Developer Guide: index.md
- Quickstart: dataset/quickstart.md
- Installing <code>kolena</code>: installing-kolena.md
- Core Concepts: dataset/core-concepts/index.md
- Use Cases: dataset/use-cases.md
- Advanced Usage:
- Advanced Usage: dataset/advanced-usage/index.md
- Formatting Datasets:
- Formatting Datasets: dataset/advanced-usage/dataset-formatting/index.md
- Computer Vision: dataset/advanced-usage/dataset-formatting/computer-vision.md
- Natural Language: dataset/advanced-usage/dataset-formatting/natural-language.md
- Audio: dataset/advanced-usage/dataset-formatting/audio.md
- Task Metrics: dataset/advanced-usage/task-metrics.md
- Thresholded Results: dataset/advanced-usage/thresholded-results.md
- Programmatically Compare Models: dataset/advanced-usage/quality-standard-results.md
- Automatically Extract Text Properties: automations/extract-text-metadata.md
- Automatically Extract Image Properties: automations/extract-image-metadata.md
- Automatically Extract Bounding Box Properties: automations/extract-bounding-box-metadata.md
- Setting Up Natural Language Search: automations/set-up-natural-language-search.md
- Uploading Custom Embeddings: dataset/advanced-usage/upload-embeddings.md
- Object Detection with Kolena: dataset/object-detection.md
- LLM Powered Data Processing: dataset/advanced-usage/llm-prompt-extraction.md
- Custom Queries and Fields: dataset/advanced-usage/custom-queries.md
- Connecting Cloud Storage:
- Connecting Cloud Storage: connecting-cloud-storage/index.md
- Amazon S3: connecting-cloud-storage/amazon-s3.md
- S3-Compatible APIs: connecting-cloud-storage/s3-compatible.md
- Google Cloud Storage: connecting-cloud-storage/google-cloud-storage.md
- Azure Blob Storage: connecting-cloud-storage/azure-blob-storage.md
- HTTP Basic: connecting-cloud-storage/http-basic.md
- Connecting External LLM Endpoint:
- Connecting External LLM Endpoint: connecting-external-llm-endpoint/index.md
- Connecting Azure OpenAI deployment: connecting-external-llm-endpoint/azure-openai.md
- Archive:
- Workflows:
- Workflows: workflow/index.md
- Quickstart: workflow/quickstart.md
- Building a Workflow: workflow/building-a-workflow.md
- Core Concepts:
- Core Concepts: workflow/core-concepts/index.md
- Workflow: workflow/core-concepts/workflow.md
- Test Case & Test Suite: workflow/core-concepts/test-suite.md
- Model: workflow/core-concepts/model.md
- Advanced Usage:
- Advanced Usage: workflow/advanced-usage/index.md
- Packaging for Automated Evaluation: workflow/advanced-usage/packaging-for-automated-evaluation.md
- Nesting Test Case Metrics: workflow/advanced-usage/nesting-test-case-metrics.md
- Uploading Activation Maps: workflow/advanced-usage/uploading-activation-maps.md
- API Reference:
- API Reference: reference/index.md
- <code>kolena.annotation</code>: reference/annotation.md
- <code>kolena.asset</code>: reference/asset.md
- <code>kolena.dataset</code>: reference/dataset/index.md
- <code>kolena.errors</code>: reference/errors.md
- <code>kolena.io</code>: reference/io.md
- <code>kolena.initialize</code>: reference/initialize.md
- <code>kolena.metrics</code>: reference/metrics.md
- <code>kolena._experimental</code>: reference/experimental/index.md
- Archived:
- <code>kolena.workflow</code>:
- <code>kolena.workflow</code>: reference/workflow/index.md
- <code>TestSample</code>: reference/workflow/test-sample.md
- <code>GroundTruth</code>: reference/workflow/ground-truth.md
- <code>Inference</code>: reference/workflow/inference.md
- <code>Evaluator</code>: reference/workflow/evaluator.md
- <code>TestCase</code>: reference/workflow/test-case.md
- <code>TestSuite</code>: reference/workflow/test-suite.md
- <code>Model</code>: reference/workflow/model.md
- <code>test</code>: reference/workflow/test-run.md
- Utilities:
- Annotations: reference/workflow/annotation.md
- Assets: reference/workflow/asset.md
- Plots: reference/workflow/plot.md
- <code>define_workflow</code>: reference/workflow/define-workflow.md
- <code>ThresholdedMetrics</code>: reference/workflow/thresholded-metrics.md
- <code>visualization</code>: reference/workflow/visualization.md
- IO: reference/workflow/io.md
- Pre-built Workflows:
- Pre-built Workflows: reference/pre-built/index.md
- Object Detection (2D): reference/pre-built/object-detection-2d.md
- Classification: reference/pre-built/classification.md
- Metrics Glossary:
- Metrics Glossary: metrics/index.md
- General:
- metrics/accuracy.md
- metrics/average-precision.md
- metrics/averaging-methods.md
- metrics/coefficient-of-determination.md
- metrics/cohens-kappa.md
- metrics/confusion-matrix.md
- metrics/f1-score.md
- metrics/fpr.md
- metrics/fnr.md
- metrics/mean-absolute-error.md
- metrics/mean-squared-error.md
- metrics/pearson-correlation.md
- metrics/precision.md
- metrics/pr-curve.md
- metrics/recall.md
- metrics/roc-curve.md
- metrics/root-mean-squared-error.md
- metrics/spearman-correlation.md
- metrics/specificity.md
- metrics/tp-fp-fn-tn.md
- Computer Vision:
- metrics/geometry-matching.md
- metrics/iou.md
- Large Language Models:
- metrics/consistency-score.md
- metrics/contradiction-score.md
- HHEM Score: metrics/HHEM-score.md
- metrics/prompt-based-hallucination-metric.md
- Natural Language Processing:
- metrics/bertscore.md
- metrics/bleu.md
- metrics/diarization-error-rate.md
- metrics/meteor.md
- metrics/perplexity.md
- metrics/rouge-n.md
- metrics/wer-cer-mer.md
- Kolena Insights:
- metrics/difficulty-score.md
- metrics/density-score.md
- metrics/uniqueness-score.md
- metrics/representation-score.md
- metrics/potential-difficulty-score.md
- metrics/statistical-significance.md
- Help & FAQ:
- Help & FAQ: faq/index.md
- Sign in ↗: https://app.kolena.com
theme:
name: material
logo: assets/images/logo-white.svg
favicon: assets/images/favicon.png
custom_dir: docs/overrides
font:
text: Inter
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
features:
- announce.dismiss
- content.action.edit
- content.code.copy
- content.tabs.link
- navigation.indexes
- navigation.footer
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- search.highlight
- search.suggest
- toc.follow
markdown_extensions:
- admonition # callouts
- footnotes
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify # NOTE: insiders only
kwds:
case: lower
- toc:
permalink: "#"
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- docs/overrides/.icons
- pymdownx.arithmatex:
generic: true
watch:
- kolena
extra_css:
- assets/css/theme.css
- assets/css/mkdocstrings.css
extra_javascript:
- assets/javascript/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
social: # render social media cards for copy+paste
cache_dir: .cache/plugin/social/free
search:
lang: en
git-revision-date-localized:
mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://docs.scipy.org/doc/numpy/objects.inv
options:
docstring_style: sphinx
merge_init_into_class: true
members_order: source # sort members in the order they are defined
show_docstring_attributes: true
show_root_toc_entry: false
show_source: false
extra:
generator: false
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/kolenaIO
name: Kolena on Twitter
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/kolena-ai
name: Kolena on LinkedIn
- icon: fontawesome/brands/python
link: https://pypi.org/project/kolena
- icon: fontawesome/brands/github
link: https://github.com/kolenaIO/kolena
name: Kolena on GitHub
- icon: kolena/logo
link: https://app.kolena.com
name: Kolena Platform
dd_rum:
client_token: !ENV [ DD_RUM_CLIENT_TOKEN, blank ]
application_id: !ENV [ DD_RUM_APPLICATION_ID, blank ]