sahi/zensical.toml at main · obss/sahi · 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
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
[project]
site_name = "SAHI Documentation"
site_url = "https://sahi.readthedocs.io/"
repo_url = "https://github.com/obss/sahi"
repo_name = "obss/sahi"
edit_uri = "https://github.com/obss/sahi/tree/main/docs"
docs_dir = "docs"
site_dir = "site"

nav = [
  {Home = "index.md"},
  {"Quick Start" = "quick-start.md"},
  {Guides = [
    {"How Sliced Inference Works" = "guides/sliced-inference.md"},
    {"Model Integrations" = "guides/models.md"},
    {"Prediction Utilities" = "predict.md"},
    {"COCO Dataset Operations" = "coco.md"},
    {"Slicing Utilities" = "slicing.md"},
    {"Postprocessing Backends" = "postprocess/backends.md"},
    {"FiftyOne Visualization" = "fiftyone.md"},
    {"CLI Commands" = "cli.md"},
  ]},
  {Notebooks = "notebooks.md"},
  {"Code Reference" = [
    {"High-level API" = [
      "predict.md",
      "slicing.md",
    ]},
    {Core = [
      "annotation.md",
      "prediction.md",
      "auto_model.md",
    ]},
    {Models = [
      "models/base.md",
      "models/ultralytics.md",
      "models/yolov5.md",
      "models/yoloe.md",
      "models/yolo-world.md",
      "models/mmdet.md",
      "models/detectron2.md",
      "models/huggingface.md",
      "models/torchvision.md",
      "models/rtdetr.md",
      "models/roboflow.md",
    ]},
    {"Post-processing" = [
      "postprocess/backends.md",
      "postprocess/combine.md",
      "postprocess/utils.md",
    ]},
    {Utils = [
      {"COCO Utils" = "utils/coco.md"},
      {"Computer Vision Utils" = "utils/cv.md"},
      {"File Utils" = "utils/file.md"},
    ]},
  ]},
  {"API Reference Index" = "api.md"},
  {Contributing = "contributing.md"},
  {License = "license.md"},
  {Changelog = "changelog.md"},
]

[project.theme]
language = "en"
variant = "material"
features = [
  "navigation.tracking",
  "content.code.copy",
  "content.action.edit",
  "content.tooltips",
  "content.code.annotate",
  "navigation.tabs",
  "navigation.tabs.sticky",
  "navigation.top",
  "navigation.indexes",
]
font.text = "Inter"
font.code = "IBM Plex Mono"
icon.edit = "material/pencil"

[[project.theme.palette]]
scheme = "default"
primary = "custom"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "custom"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to light mode"

# --- Alternate languages ---

[[project.extra.alternate]]
name = "English"
link = "/"
lang = "en"

[[project.extra.alternate]]
name = "中文"
link = "/zh/"
lang = "zh"

# --- Social links ---

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/obss/sahi"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/sahi"

# --- Plugins ---

[project.plugins.search]

[project.plugins.mkdocstrings]
default_handler = "python"


[project.plugins.mkdocstrings.handlers.python.options]
parameter_headings = true
allow_inspection = true
show_bases = true
group_by_category = true
docstring_style = "google"
show_symbol_type_heading = true
show_root_heading = true
show_symbol_type_toc = true
show_category_heading = true


# --- Python Markdown extensions ---

[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]

[project.markdown_extensions.toc]
permalink = true

# --- PyMdown extensions ---

[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.pymdownx.snippets]
check_paths = true

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.arithmatex]
generic = true

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"