-
Notifications
You must be signed in to change notification settings - Fork 30
/
mkdocs.yml
135 lines (126 loc) · 4.36 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
## Project information
site_name: Python SDK
site_description: Kili Python SDK
site_url: https://python-sdk-docs.kili-technology.com/
## Repository
repo_url: https://github.com/kili-technology/kili-python-sdk
repo_name: Kili Python SDK
edit_uri: "" #disables edit button
## Site Architecture
nav:
- Python SDK:
- Getting Started: index.md
- Tutorials: tutorials.md
- Reference:
- Asset: sdk/asset.md
- Cloud Storage: sdk/cloud_storage.md
- Event: sdk/event.md
- Issue: sdk/issue.md
- Label: sdk/label.md
- Label Utils: sdk/label_utils.md
- Label Parsing: sdk/label_parsing.md
- LLM: sdk/llm.md
- Notification: sdk/notification.md
- Organization: sdk/organization.md
- Plugins: sdk/plugins.md
- Project: sdk/project.md
- Project User: sdk/project_user.md
- Project Version: sdk/project_version.md
- Tag: sdk/tag.md
- User: sdk/user.md
- Command Line Interface:
- Getting Started: cli/index.md
- Reference: cli/reference.md
- Tutorials:
- Getting Started: tutorials.md
- Basic Project Setup: sdk/tutorials/basic_project_setup.md
- Importing Assets:
- Importing Assets: sdk/tutorials/importing_assets_and_metadata.md
- Video Assets: sdk/tutorials/importing_video_assets.md
- PDF Assets: sdk/tutorials/importing_pdf_assets.md
- Rich Text Assets: sdk/tutorials/import_text_assets.md
- Multi-Layer Geosatellite Assets: sdk/tutorials/importing_multilayer_geosat_assets.md
- Importing Labels:
- Importing Labels: sdk/tutorials/importing_labels.md
- OpenAI NER Pre-annotations: sdk/tutorials/ner_pre_annotations_openai.md
- OCR Pre-annotations: sdk/tutorials/ocr_pre_annotations.md
- Segmentation Pre-annotations: sdk/tutorials/pixel_level_masks.md
- Inference Labels: sdk/tutorials/inference_labels.md
- DINOv2 Classification Pre-annotations: sdk/tutorials/finetuning_dinov2.md
- Converting Labels:
- DICOM: sdk/tutorials/medical_imaging.md
- Tagtog: sdk/tutorials/tagtog_to_kili.md
- COCO: sdk/tutorials/importing_coco.md
- PascalVOC: sdk/tutorials/importing_pascalvoc.md
- GeoJSON: sdk/tutorials/geojson.md
- Managing Workflows: sdk/tutorials/set_up_workflows.md
- Exporting Project Data:
- Exporting a Project: sdk/tutorials/export_a_kili_project.md
- Parsing Labels: sdk/tutorials/label_parsing.md
- LLM Projects: sdk/tutorials/llm_project_setup.md
- Setting Up Plugins:
- Developing Plugins: sdk/tutorials/plugins_development.md
- Plugin Example - Programmatic QA: sdk/tutorials/plugins_example.md
- Plugins Library: sdk/tutorials/plugins_library.md
- Webhooks: sdk/tutorials/webhooks_example.md
- Integrations:
- Vertex AI AutoML: sdk/tutorials/vertex_ai_automl_od.md
## Configuration
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_root_heading: false
heading_level: 3
show_source: true
show_category_heading: false
show_root_toc_entry: false
docstring_style: google
filters:
- "!^__" # exclude all members starting with __
docstring_options:
replace_admonitions: yes
- mike:
version_selector: true
watch:
- src/kili
markdown_extensions:
- admonition
- def_list
- mkdocs-click
- attr_list
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra:
version:
provider: mike
analytics:
provider: google
property: G-HRVEXSEWL0
## Theme and Design
theme:
name: "material"
palette:
scheme: kili
logo: assets/kili_logo.png
favicon: assets/kili_favicon.ico
language: en
font:
text: Archia
features:
- navigation.tabs
extra_css:
- stylesheets/extra.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.4/katex.min.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.4/katex.min.js
- extra_javascript/katex.js