usls/mkdocs.yml at main · jamjamjon/usls · GitHub

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
site_name: usls
site_description: A cross-platform Rust library for efficient inference of SOTA vision and vision-language models.
site_author: jamjamjon
repo_name: jamjamjon/usls
repo_url: https://github.com/jamjamjon/usls
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view

  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jamjamjon/usls

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Integration: getting-started/integration.md
  - Cargo Features:
    - Overview: cargo-features/overview.md
    - ONNX Runtime Version: cargo-features/ort.md
    - Execution Provider: cargo-features/ep.md
    - Image Formats: cargo-features/image-formats.md
    - Model Categories: cargo-features/models.md
    - Utilities: cargo-features/utils.md
  - Guides:
    - Overview: guides/overview.md
    - Config System: guides/config.md
    - Hub (GitHub / Hugging Face): guides/hub.md
    - Data Loading: guides/dataloader.md
    - Execution Providers: guides/ep.md
    - DType & Quantization: guides/dtype.md
    - Device Management: guides/device.md
    - Results: guides/results.md
    - Annotator: guides/annotator.md
    - Visualization: guides/visualization.md
  - Model Zoo:
    - Overview: model-zoo/overview.md
    - YOLO Series: model-zoo/yolo.md
    - Classification & Tagging: model-zoo/classification.md
    - Object Detection: model-zoo/detection.md
    - Image Segmentation: model-zoo/segmentation.md
    - Background Removal: model-zoo/background-removal.md
    - Gaze Estimation: model-zoo/gaze.md
    - Image Matting: model-zoo/matting.md
    - Open-Set Detection: model-zoo/open-set.md
    - Multi-Object Tracking: model-zoo/tracking.md
    - Super Resolution: model-zoo/super-resolution.md
    - Pose Estimation: model-zoo/pose.md
    - OCR & Documents: model-zoo/ocr.md
    - Vision-Language Models: model-zoo/vlm.md
    - Embedding Models: model-zoo/embedding.md
    - Depth Estimation: model-zoo/depth.md
    - Others: model-zoo/others.md
  - FAQ: faq.md
  - Contributing: contributing.md
  - API Reference: https://docs.rs/usls/latest/usls/