forked from ultralytics/ultralytics
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
937 lines (924 loc) · 43.3 KB
/
Copy pathmkdocs.yml
File metadata and controls
937 lines (924 loc) · 43.3 KB
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
# Configuration file for building the Ultralytics YOLO documentation site using MkDocs.
# Provides settings to control site metadata, customize the appearance using the
# Material theme, define the navigation structure, and enable various plugins.
# Site metadata
site_name: Ultralytics YOLO Docs
site_description: Explore Ultralytics YOLO, a cutting-edge real-time model for object detection, segmentation, semantic segmentation, classification, pose estimation, and tracking across various applications and hardware platforms.
site_url: https://docs.ultralytics.com
site_author: Ultralytics
repo_url: https://github.com/ultralytics/ultralytics
edit_uri: https://github.com/ultralytics/ultralytics/tree/main/docs/en/
repo_name: ultralytics/ultralytics
remote_name: https://github.com/ultralytics/docs
docs_dir: "docs/en/" # where to find the markdown files
site_dir: "site/" # where to publish to
use_directory_urls: true # use directory-style URLs instead of file-based paths
# Theme customization
theme:
name: material
language: en
custom_dir: docs/overrides/
logo: https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Reverse.svg
favicon: https://raw.githubusercontent.com/ultralytics/assets/refs/heads/main/logo/favicon-yolo.png
icon:
repo: fontawesome/brands/github
# font: # disabled for faster page load times
# text: Helvetica
# code: Roboto Mono
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to system preference
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- content.tooltips
- toc.follow
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- navigation.prune
- navigation.footer
- navigation.tracking
- navigation.instant
- navigation.instant.progress
- announce.dismiss
- navigation.indexes
- navigation.sections # groups top-level sections instead of expanding all
- content.tabs.link # all content tabs with the same label change simultaneously
# - search.highlight
# - search.share
# - search.suggest
# Customization
copyright: <a href="https://www.ultralytics.com/" target="_blank">© 2026 Ultralytics Inc.</a> All rights reserved.
extra: # version:
homepage: https://www.ultralytics.com/
# provider: mike # version drop-down menu
robots: robots.txt
analytics:
provider: google
property: G-2M5EHKC0BH
social:
- icon: fontawesome/brands/github
link: https://github.com/ultralytics
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/ultralytics/
- icon: fontawesome/brands/x-twitter
link: https://x.com/ultralytics
- icon: fontawesome/brands/youtube
link: https://youtube.com/ultralytics?sub_confirmation=1
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/ultralytics/ultralytics/
- icon: fontawesome/brands/python
link: https://pypi.org/project/ultralytics/
- icon: fontawesome/brands/discord
link: https://discord.com/invite/ultralytics
- icon: fontawesome/brands/reddit
link: https://reddit.com/r/ultralytics
- icon: fontawesome/brands/weixin
link: https://weixin.qq.com/r/mp/LxckPDfEgWr_rXNf90I9
alternate:
- name: 🇬🇧 English
link: /
lang: en
- name: 🇨🇳 简体中文
link: /zh/
lang: zh
- name: 🇰🇷 한국어
link: /ko/
lang: ko
- name: 🇯🇵 日本語
link: /ja/
lang: ja
- name: 🇷🇺 Русский
link: /ru/
lang: ru
- name: 🇩🇪 Deutsch
link: /de/
lang: de
- name: 🇫🇷 Français
link: /fr/
lang: fr
- name: 🇪🇸 Español
link: /es/
lang: es
- name: 🇵🇹 Português
link: /pt/
lang: pt
- name: 🇮🇹 Italiano
link: /it/
lang: it
- name: 🇹🇷 Türkçe
link: /tr/
lang: tr
- name: 🇻🇳 Tiếng Việt
link: /vi/
lang: vi
- name: 🇸🇦 العربية
link: /ar/
lang: ar
extra_css:
- stylesheets/style.css
extra_javascript:
- https://cdn.jsdelivr.net/gh/ultralytics/llm@v0.2.8/js/chat.min.js
- https://unpkg.com/tablesort@5.7.0/dist/tablesort.min.js
- javascript/extra.js
- javascript/giscus.js
- javascript/tablesort.js
markdown_extensions:
- admonition
- md_in_html
- tables
- attr_list
- def_list
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.snippets:
base_path: ./
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
# Validation settings https://www.mkdocs.org/user-guide/configuration/#validation
validation:
nav:
omitted_files: info
not_found: warn
absolute_links: info
links:
absolute_links: relative_to_docs
anchors: warn
unrecognized_links: warn
# Zensical treats bracketed examples like [0, 1] and [x1, y1, x2, y2] as shortcut references.
unresolved_references: false
# Primary navigation ---------------------------------------------------------------------------------------------------
not_in_nav: |
/macros
nav:
- Home:
- Home: index.md
- Quickstart: quickstart.md
- Usage:
- CLI: usage/cli.md
- Python: usage/python.md
- Callbacks: usage/callbacks.md
- Configuration: usage/cfg.md
- Simple Utilities: usage/simple-utilities.md
- Advanced Customization: usage/engine.md
- YOLO26 🚀: models/yolo26.md
- Languages:
- 🇬🇧  English: https://ultralytics.com/docs/
- 🇨🇳  简体中文: https://docs.ultralytics.com/zh/
- 🇰🇷  한국어: https://docs.ultralytics.com/ko/
- 🇯🇵  日本語: https://docs.ultralytics.com/ja/
- 🇷🇺  Русский: https://docs.ultralytics.com/ru/
- 🇩🇪  Deutsch: https://docs.ultralytics.com/de/
- 🇫🇷  Français: https://docs.ultralytics.com/fr/
- 🇪🇸  Español: https://docs.ultralytics.com/es/
- 🇵🇹  Português: https://docs.ultralytics.com/pt/
- 🇮🇹  Italiano: https://docs.ultralytics.com/it/
- 🇹🇷  Türkçe: https://docs.ultralytics.com/tr/
- 🇻🇳  Tiếng Việt: https://docs.ultralytics.com/vi/
- 🇸🇦  العربية: https://docs.ultralytics.com/ar/
- Modes:
- modes/index.md
- Train: modes/train.md
- Val: modes/val.md
- Predict: modes/predict.md
- Export: modes/export.md
- Track: modes/track.md
- Benchmark: modes/benchmark.md
- Tasks:
- tasks/index.md
- Detect: tasks/detect.md
- Segment: tasks/segment.md
- Semantic: tasks/semantic.md
- Classify: tasks/classify.md
- Pose: tasks/pose.md
- OBB: tasks/obb.md
- Models:
- models/index.md
- YOLOv3: models/yolov3.md
- YOLOv4: models/yolov4.md
- YOLOv5: models/yolov5.md
- YOLOv6: models/yolov6.md
- YOLOv7: models/yolov7.md
- YOLOv8: models/yolov8.md
- YOLOv9: models/yolov9.md
- YOLOv10: models/yolov10.md
- YOLO11: models/yolo11.md
- YOLO12: models/yolo12.md
- YOLO26 🚀: models/yolo26.md
- SAM (Segment Anything Model): models/sam.md
- SAM 2 (Segment Anything Model 2): models/sam-2.md
- SAM 3 (Segment Anything Model 3): models/sam-3.md
- MobileSAM (Mobile Segment Anything Model): models/mobile-sam.md
- FastSAM (Fast Segment Anything Model): models/fast-sam.md
- YOLO-NAS (Neural Architecture Search): models/yolo-nas.md
- RT-DETR (Realtime Detection Transformer): models/rtdetr.md
- YOLO-World (Real-Time Open-Vocabulary Object Detection): models/yolo-world.md
- YOLOE (Real-Time Seeing Anything): models/yoloe.md
- Compare:
- compare/index.md
- YOLO26:
- YOLO26 vs YOLO11: compare/yolo26-vs-yolo11.md
- YOLO26 vs YOLOv10: compare/yolo26-vs-yolov10.md
- YOLO26 vs YOLOv9: compare/yolo26-vs-yolov9.md
- YOLO26 vs YOLOv8: compare/yolo26-vs-yolov8.md
- YOLO26 vs YOLOv7: compare/yolo26-vs-yolov7.md
- YOLO26 vs YOLOv6: compare/yolo26-vs-yolov6.md
- YOLO26 vs YOLOv5: compare/yolo26-vs-yolov5.md
- YOLO26 vs RT-DETR: compare/yolo26-vs-rtdetr.md
- YOLO26 vs PP-YOLOE+: compare/yolo26-vs-pp-yoloe.md
- YOLO26 vs DAMO-YOLO: compare/yolo26-vs-damo-yolo.md
- YOLO26 vs YOLOX: compare/yolo26-vs-yolox.md
- YOLO26 vs EfficientDet: compare/yolo26-vs-efficientdet.md
- YOLO11:
- YOLO11 vs YOLO26: compare/yolo11-vs-yolo26.md
- YOLO11 vs YOLOv10: compare/yolo11-vs-yolov10.md
- YOLO11 vs YOLOv9: compare/yolo11-vs-yolov9.md
- YOLO11 vs YOLOv8: compare/yolo11-vs-yolov8.md
- YOLO11 vs YOLOv7: compare/yolo11-vs-yolov7.md
- YOLO11 vs YOLOv6: compare/yolo11-vs-yolov6.md
- YOLO11 vs YOLOv5: compare/yolo11-vs-yolov5.md
- YOLO11 vs RT-DETR: compare/yolo11-vs-rtdetr.md
- YOLO11 vs PP-YOLOE+: compare/yolo11-vs-pp-yoloe.md
- YOLO11 vs DAMO-YOLO: compare/yolo11-vs-damo-yolo.md
- YOLO11 vs YOLOX: compare/yolo11-vs-yolox.md
- YOLO11 vs EfficientDet: compare/yolo11-vs-efficientdet.md
- YOLOv10:
- YOLOv10 vs YOLO26: compare/yolov10-vs-yolo26.md
- YOLOv10 vs YOLO11: compare/yolov10-vs-yolo11.md
- YOLOv10 vs YOLOv9: compare/yolov10-vs-yolov9.md
- YOLOv10 vs YOLOv8: compare/yolov10-vs-yolov8.md
- YOLOv10 vs YOLOv7: compare/yolov10-vs-yolov7.md
- YOLOv10 vs YOLOv6: compare/yolov10-vs-yolov6.md
- YOLOv10 vs YOLOv5: compare/yolov10-vs-yolov5.md
- YOLOv10 vs RT-DETR: compare/yolov10-vs-rtdetr.md
- YOLOv10 vs PP-YOLOE+: compare/yolov10-vs-pp-yoloe.md
- YOLOv10 vs DAMO-YOLO: compare/yolov10-vs-damo-yolo.md
- YOLOv10 vs YOLOX: compare/yolov10-vs-yolox.md
- YOLOv10 vs EfficientDet: compare/yolov10-vs-efficientdet.md
- YOLOv9:
- YOLOv9 vs YOLO26: compare/yolov9-vs-yolo26.md
- YOLOv9 vs YOLO11: compare/yolov9-vs-yolo11.md
- YOLOv9 vs YOLOv10: compare/yolov9-vs-yolov10.md
- YOLOv9 vs YOLOv8: compare/yolov9-vs-yolov8.md
- YOLOv9 vs YOLOv7: compare/yolov9-vs-yolov7.md
- YOLOv9 vs YOLOv6: compare/yolov9-vs-yolov6.md
- YOLOv9 vs YOLOv5: compare/yolov9-vs-yolov5.md
- YOLOv9 vs RT-DETR: compare/yolov9-vs-rtdetr.md
- YOLOv9 vs PP-YOLOE+: compare/yolov9-vs-pp-yoloe.md
- YOLOv9 vs DAMO-YOLO: compare/yolov9-vs-damo-yolo.md
- YOLOv9 vs YOLOX: compare/yolov9-vs-yolox.md
- YOLOv9 vs EfficientDet: compare/yolov9-vs-efficientdet.md
- YOLOv8:
- YOLOv8 vs YOLO26: compare/yolov8-vs-yolo26.md
- YOLOv8 vs YOLO11: compare/yolov8-vs-yolo11.md
- YOLOv8 vs YOLOv10: compare/yolov8-vs-yolov10.md
- YOLOv8 vs YOLOv9: compare/yolov8-vs-yolov9.md
- YOLOv8 vs YOLOv7: compare/yolov8-vs-yolov7.md
- YOLOv8 vs YOLOv6: compare/yolov8-vs-yolov6.md
- YOLOv8 vs YOLOv5: compare/yolov8-vs-yolov5.md
- YOLOv8 vs RT-DETR: compare/yolov8-vs-rtdetr.md
- YOLOv8 vs PP-YOLOE+: compare/yolov8-vs-pp-yoloe.md
- YOLOv8 vs DAMO-YOLO: compare/yolov8-vs-damo-yolo.md
- YOLOv8 vs YOLOX: compare/yolov8-vs-yolox.md
- YOLOv8 vs EfficientDet: compare/yolov8-vs-efficientdet.md
- YOLOv7:
- YOLOv7 vs YOLO26: compare/yolov7-vs-yolo26.md
- YOLOv7 vs YOLO11: compare/yolov7-vs-yolo11.md
- YOLOv7 vs YOLOv10: compare/yolov7-vs-yolov10.md
- YOLOv7 vs YOLOv9: compare/yolov7-vs-yolov9.md
- YOLOv7 vs YOLOv8: compare/yolov7-vs-yolov8.md
- YOLOv7 vs YOLOv6: compare/yolov7-vs-yolov6.md
- YOLOv7 vs YOLOv5: compare/yolov7-vs-yolov5.md
- YOLOv7 vs RT-DETR: compare/yolov7-vs-rtdetr.md
- YOLOv7 vs PP-YOLOE+: compare/yolov7-vs-pp-yoloe.md
- YOLOv7 vs DAMO-YOLO: compare/yolov7-vs-damo-yolo.md
- YOLOv7 vs YOLOX: compare/yolov7-vs-yolox.md
- YOLOv7 vs EfficientDet: compare/yolov7-vs-efficientdet.md
- YOLOv6:
- YOLOv6 vs YOLO26: compare/yolov6-vs-yolo26.md
- YOLOv6 vs YOLO11: compare/yolov6-vs-yolo11.md
- YOLOv6 vs YOLOv10: compare/yolov6-vs-yolov10.md
- YOLOv6 vs YOLOv9: compare/yolov6-vs-yolov9.md
- YOLOv6 vs YOLOv8: compare/yolov6-vs-yolov8.md
- YOLOv6 vs YOLOv7: compare/yolov6-vs-yolov7.md
- YOLOv6 vs YOLOv5: compare/yolov6-vs-yolov5.md
- YOLOv6 vs RT-DETR: compare/yolov6-vs-rtdetr.md
- YOLOv6 vs PP-YOLOE+: compare/yolov6-vs-pp-yoloe.md
- YOLOv6 vs DAMO-YOLO: compare/yolov6-vs-damo-yolo.md
- YOLOv6 vs YOLOX: compare/yolov6-vs-yolox.md
- YOLOv6 vs EfficientDet: compare/yolov6-vs-efficientdet.md
- YOLOv5:
- YOLOv5 vs YOLO26: compare/yolov5-vs-yolo26.md
- YOLOv5 vs YOLO11: compare/yolov5-vs-yolo11.md
- YOLOv5 vs YOLOv10: compare/yolov5-vs-yolov10.md
- YOLOv5 vs YOLOv9: compare/yolov5-vs-yolov9.md
- YOLOv5 vs YOLOv8: compare/yolov5-vs-yolov8.md
- YOLOv5 vs YOLOv7: compare/yolov5-vs-yolov7.md
- YOLOv5 vs YOLOv6: compare/yolov5-vs-yolov6.md
- YOLOv5 vs RT-DETR: compare/yolov5-vs-rtdetr.md
- YOLOv5 vs PP-YOLOE+: compare/yolov5-vs-pp-yoloe.md
- YOLOv5 vs DAMO-YOLO: compare/yolov5-vs-damo-yolo.md
- YOLOv5 vs YOLOX: compare/yolov5-vs-yolox.md
- YOLOv5 vs EfficientDet: compare/yolov5-vs-efficientdet.md
- RT-DETR:
- RT-DETR vs YOLO26: compare/rtdetr-vs-yolo26.md
- RT-DETR vs YOLO11: compare/rtdetr-vs-yolo11.md
- RT-DETR vs YOLOv10: compare/rtdetr-vs-yolov10.md
- RT-DETR vs YOLOv9: compare/rtdetr-vs-yolov9.md
- RT-DETR vs YOLOv8: compare/rtdetr-vs-yolov8.md
- RT-DETR vs YOLOv7: compare/rtdetr-vs-yolov7.md
- RT-DETR vs YOLOv6: compare/rtdetr-vs-yolov6.md
- RT-DETR vs YOLOv5: compare/rtdetr-vs-yolov5.md
- RT-DETR vs PP-YOLOE+: compare/rtdetr-vs-pp-yoloe.md
- RT-DETR vs DAMO-YOLO: compare/rtdetr-vs-damo-yolo.md
- RT-DETR vs YOLOX: compare/rtdetr-vs-yolox.md
- RT-DETR vs EfficientDet: compare/rtdetr-vs-efficientdet.md
- PP-YOLOE+:
- PP-YOLOE+ vs YOLO26: compare/pp-yoloe-vs-yolo26.md
- PP-YOLOE+ vs YOLO11: compare/pp-yoloe-vs-yolo11.md
- PP-YOLOE+ vs YOLOv10: compare/pp-yoloe-vs-yolov10.md
- PP-YOLOE+ vs YOLOv9: compare/pp-yoloe-vs-yolov9.md
- PP-YOLOE+ vs YOLOv8: compare/pp-yoloe-vs-yolov8.md
- PP-YOLOE+ vs YOLOv7: compare/pp-yoloe-vs-yolov7.md
- PP-YOLOE+ vs YOLOv6: compare/pp-yoloe-vs-yolov6.md
- PP-YOLOE+ vs YOLOv5: compare/pp-yoloe-vs-yolov5.md
- PP-YOLOE+ vs RT-DETR: compare/pp-yoloe-vs-rtdetr.md
- PP-YOLOE+ vs DAMO-YOLO: compare/pp-yoloe-vs-damo-yolo.md
- PP-YOLOE+ vs YOLOX: compare/pp-yoloe-vs-yolox.md
- PP-YOLOE+ vs EfficientDet: compare/pp-yoloe-vs-efficientdet.md
- DAMO-YOLO:
- DAMO-YOLO vs YOLO26: compare/damo-yolo-vs-yolo26.md
- DAMO-YOLO vs YOLO11: compare/damo-yolo-vs-yolo11.md
- DAMO-YOLO vs YOLOv10: compare/damo-yolo-vs-yolov10.md
- DAMO-YOLO vs YOLOv9: compare/damo-yolo-vs-yolov9.md
- DAMO-YOLO vs YOLOv8: compare/damo-yolo-vs-yolov8.md
- DAMO-YOLO vs YOLOv7: compare/damo-yolo-vs-yolov7.md
- DAMO-YOLO vs YOLOv6: compare/damo-yolo-vs-yolov6.md
- DAMO-YOLO vs YOLOv5: compare/damo-yolo-vs-yolov5.md
- DAMO-YOLO vs RT-DETR: compare/damo-yolo-vs-rtdetr.md
- DAMO-YOLO vs PP-YOLOE+: compare/damo-yolo-vs-pp-yoloe.md
- DAMO-YOLO vs YOLOX: compare/damo-yolo-vs-yolox.md
- DAMO-YOLO vs EfficientDet: compare/damo-yolo-vs-efficientdet.md
- YOLOX:
- YOLOX vs YOLO26: compare/yolox-vs-yolo26.md
- YOLOX vs YOLO11: compare/yolox-vs-yolo11.md
- YOLOX vs YOLOv10: compare/yolox-vs-yolov10.md
- YOLOX vs YOLOv9: compare/yolox-vs-yolov9.md
- YOLOX vs YOLOv8: compare/yolox-vs-yolov8.md
- YOLOX vs YOLOv7: compare/yolox-vs-yolov7.md
- YOLOX vs YOLOv6: compare/yolox-vs-yolov6.md
- YOLOX vs YOLOv5: compare/yolox-vs-yolov5.md
- YOLOX vs RT-DETR: compare/yolox-vs-rtdetr.md
- YOLOX vs PP-YOLOE+: compare/yolox-vs-pp-yoloe.md
- YOLOX vs DAMO-YOLO: compare/yolox-vs-damo-yolo.md
- YOLOX vs EfficientDet: compare/yolox-vs-efficientdet.md
- EfficientDet:
- EfficientDet vs YOLO26: compare/efficientdet-vs-yolo26.md
- EfficientDet vs YOLO11: compare/efficientdet-vs-yolo11.md
- EfficientDet vs YOLOv10: compare/efficientdet-vs-yolov10.md
- EfficientDet vs YOLOv9: compare/efficientdet-vs-yolov9.md
- EfficientDet vs YOLOv8: compare/efficientdet-vs-yolov8.md
- EfficientDet vs YOLOv7: compare/efficientdet-vs-yolov7.md
- EfficientDet vs YOLOv6: compare/efficientdet-vs-yolov6.md
- EfficientDet vs YOLOv5: compare/efficientdet-vs-yolov5.md
- EfficientDet vs RT-DETR: compare/efficientdet-vs-rtdetr.md
- EfficientDet vs PP-YOLOE+: compare/efficientdet-vs-pp-yoloe.md
- EfficientDet vs DAMO-YOLO: compare/efficientdet-vs-damo-yolo.md
- EfficientDet vs YOLOX: compare/efficientdet-vs-yolox.md
- Datasets:
- Datasets: datasets/index.md
- Detection:
- datasets/detect/index.md
- African-wildlife: datasets/detect/african-wildlife.md
- Argoverse: datasets/detect/argoverse.md
- Brain-tumor: datasets/detect/brain-tumor.md
- COCO: datasets/detect/coco.md
- COCO8: datasets/detect/coco8.md
- COCO8-Grayscale: datasets/detect/coco8-grayscale.md
- COCO8-Multispectral: datasets/detect/coco8-multispectral.md
- COCO12-Formats: datasets/detect/coco12-formats.md
- COCO128: datasets/detect/coco128.md
- Construction-PPE: datasets/detect/construction-ppe.md
- GlobalWheat2020: datasets/detect/globalwheat2020.md
- HomeObjects-3K: datasets/detect/homeobjects-3k.md
- KITTI: datasets/detect/kitti.md
- LVIS: datasets/detect/lvis.md
- Medical-pills: datasets/detect/medical-pills.md
- Objects365: datasets/detect/objects365.md
- OpenImagesV7: datasets/detect/open-images-v7.md
- RF100: datasets/detect/roboflow-100.md
- Signature: datasets/detect/signature.md
- SKU-110K: datasets/detect/sku-110k.md
- TT100K: datasets/detect/tt100k.md
- VisDrone: datasets/detect/visdrone.md
- VOC: datasets/detect/voc.md
- xView: datasets/detect/xview.md
- Segmentation:
- datasets/segment/index.md
- Carparts-seg: datasets/segment/carparts-seg.md
- COCO: datasets/segment/coco.md
- COCO8-seg: datasets/segment/coco8-seg.md
- COCO128-seg: datasets/segment/coco128-seg.md
- Crack-seg: datasets/segment/crack-seg.md
- Package-seg: datasets/segment/package-seg.md
- Semantic Segmentation:
- datasets/semantic/index.md
- Cityscapes: datasets/semantic/cityscapes.md
- Cityscapes8: datasets/semantic/cityscapes8.md
- ADE20K: datasets/semantic/ade20k.md
- Pose:
- datasets/pose/index.md
- COCO: datasets/pose/coco.md
- COCO8-pose: datasets/pose/coco8-pose.md
- Dog-pose: datasets/pose/dog-pose.md
- Hand-keypoints: datasets/pose/hand-keypoints.md
- Tiger-pose: datasets/pose/tiger-pose.md
- Classification:
- datasets/classify/index.md
- Caltech 101: datasets/classify/caltech101.md
- Caltech 256: datasets/classify/caltech256.md
- CIFAR-10: datasets/classify/cifar10.md
- CIFAR-100: datasets/classify/cifar100.md
- Fashion-MNIST: datasets/classify/fashion-mnist.md
- ImageNet: datasets/classify/imagenet.md
- ImageNet-10: datasets/classify/imagenet10.md
- Imagenette: datasets/classify/imagenette.md
- Imagewoof: datasets/classify/imagewoof.md
- MNIST: datasets/classify/mnist.md
- Oriented Bounding Boxes (OBB):
- datasets/obb/index.md
- DOTA8: datasets/obb/dota8.md
- DOTA128: datasets/obb/dota128.md
- DOTAv2: datasets/obb/dota-v2.md
- Multi-Object Tracking:
- datasets/track/index.md
- Solutions:
- Solutions: solutions/index.md
- Analytics: guides/analytics.md
- Distance Calculation: guides/distance-calculation.md
- Heatmaps: guides/heatmaps.md
- Instance Segmentation with Object Tracking: guides/instance-segmentation-and-tracking.md
- Live Inference: guides/streamlit-live-inference.md
- Object Blurring: guides/object-blurring.md
- Object Counting: guides/object-counting.md
- Object Cropping: guides/object-cropping.md
- Objects Counting in Regions: guides/region-counting.md
- Parking Management: guides/parking-management.md
- Queue Management: guides/queue-management.md
- Security Alarm System: guides/security-alarm-system.md
- Similarity Search: guides/similarity-search.md
- Speed Estimation: guides/speed-estimation.md
- Track Objects in Zone: guides/trackzone.md
- VisionEye View Objects Mapping: guides/vision-eye.md
- Workouts Monitoring: guides/workouts-monitoring.md
- Guides:
- Guides: guides/index.md
- A Guide on Model Testing: guides/model-testing.md
- AzureML Quickstart: guides/azureml-quickstart.md
- Best Practices for Model Deployment: guides/model-deployment-practices.md
- COCO to YOLO Conversion: guides/coco-to-yolo.md
- COCO JSON Training: guides/coco-json-training.md
- Conda Quickstart: guides/conda-quickstart.md
- Customizing Trainer: guides/custom-trainer.md
- Data Collection and Annotation: guides/data-collection-and-annotation.md
- DeepStream on NVIDIA Jetson: guides/deepstream-nvidia-jetson.md
- Defining A Computer Vision Project's Goals: guides/defining-project-goals.md
- Deploying YOLO on Vertex AI in Docker container: guides/vertex-ai-deployment-with-docker.md
- Docker Quickstart: guides/docker-quickstart.md
- Edge TPU on Raspberry Pi: guides/coral-edge-tpu-on-raspberry-pi.md
- End-to-End Detection: guides/end2end-detection.md
- Export Non-YOLO Models: guides/export-non-yolo-models.md
- Fine-Tuning YOLO on Custom Data: guides/finetuning-guide.md
- Hyperparameter Tuning: guides/hyperparameter-tuning.md
- Insights on Model Evaluation and Fine-Tuning: guides/model-evaluation-insights.md
- Isolating Segmentation Objects: guides/isolating-segmentation-objects.md
- K-Fold Cross Validation: guides/kfold-cross-validation.md
- Maintaining Your Computer Vision Model: guides/model-monitoring-and-maintenance.md
- Modal Quickstart: guides/modal-quickstart.md
- Model Deployment Options: guides/model-deployment-options.md
- Model YAML Configuration Guide: guides/model-yaml-config.md
- NVIDIA DALI GPU Preprocessing: guides/nvidia-dali.md
- NVIDIA DGX Spark: guides/nvidia-dgx-spark.md
- NVIDIA Jetson: guides/nvidia-jetson.md
- OpenVINO Latency vs Throughput modes: guides/optimizing-openvino-latency-vs-throughput-modes.md
- Preprocessing Annotated Data: guides/preprocessing_annotated_data.md
- Raspberry Pi: guides/raspberry-pi.md
- ROS Quickstart: guides/ros-quickstart.md
- SAHI Tiled Inference: guides/sahi-tiled-inference.md
- Steps of a Computer Vision Project: guides/steps-of-a-cv-project.md
- Tips for Model Training: guides/model-training-tips.md
- Triton Inference Server: guides/triton-inference-server.md
- Viewing Inference Images in a Terminal: guides/view-results-in-terminal.md
- YOLO26 Training Recipe: guides/yolo26-training-recipe.md
- YOLO Common Issues: guides/yolo-common-issues.md
- YOLO Data Augmentation: guides/yolo-data-augmentation.md
- YOLO Performance Metrics: guides/yolo-performance-metrics.md
- YOLO Thread-Safe Inference: guides/yolo-thread-safe-inference.md
- Explorer:
- datasets/explorer/index.md
- Explorer API: datasets/explorer/api.md
- Explorer Dashboard Demo: datasets/explorer/dashboard.md
- VOC Exploration Example: datasets/explorer/explorer.md
- YOLOv5:
- yolov5/index.md
- Quickstart: yolov5/quickstart_tutorial.md
- Environments:
- Amazon Web Services (AWS): yolov5/environments/aws_quickstart_tutorial.md
- Google Cloud (GCP): yolov5/environments/google_cloud_quickstart_tutorial.md
- AzureML: yolov5/environments/azureml_quickstart_tutorial.md
- Docker Image: yolov5/environments/docker_image_quickstart_tutorial.md
- Tutorials:
- Train Custom Data: yolov5/tutorials/train_custom_data.md
- Tips for Best Training Results: yolov5/tutorials/tips_for_best_training_results.md
- Multi-GPU Training: yolov5/tutorials/multi_gpu_training.md
- PyTorch Hub: yolov5/tutorials/pytorch_hub_model_loading.md
- TFLite, ONNX, CoreML, TensorRT Export: yolov5/tutorials/model_export.md
- Test-Time Augmentation (TTA): yolov5/tutorials/test_time_augmentation.md
- Model Ensembling: yolov5/tutorials/model_ensembling.md
- Pruning/Sparsity Tutorial: yolov5/tutorials/model_pruning_and_sparsity.md
- Hyperparameter evolution: yolov5/tutorials/hyperparameter_evolution.md
- Transfer learning with frozen layers: yolov5/tutorials/transfer_learning_with_frozen_layers.md
- Architecture Summary: yolov5/tutorials/architecture_description.md
- Neural Magic's DeepSparse: yolov5/tutorials/neural_magic_pruning_quantization.md
- Comet Logging: yolov5/tutorials/comet_logging_integration.md
- Clearml Logging: yolov5/tutorials/clearml_logging_integration.md
- Integrations:
- Integrations: integrations/index.md
- Albumentations: integrations/albumentations.md
- Amazon SageMaker: integrations/amazon-sagemaker.md
- Axelera: integrations/axelera.md
- ClearML: integrations/clearml.md
- Comet ML: integrations/comet.md
- CoreML: integrations/coreml.md
- DEEPX: integrations/deepx.md
- DVC: integrations/dvc.md
- ExecuTorch: integrations/executorch.md
- Google Colab: integrations/google-colab.md
- Gradio: integrations/gradio.md
- Hailo: integrations/hailo.md
- IBM Watsonx: integrations/ibm-watsonx.md
- JupyterLab: integrations/jupyterlab.md
- Kaggle: integrations/kaggle.md
- MLflow: integrations/mlflow.md
- MNN: integrations/mnn.md
- NCNN: integrations/ncnn.md
- Neptune: integrations/neptune.md
- Neural Magic: integrations/neural-magic.md
- ONNX: integrations/onnx.md
- OpenVINO: integrations/openvino.md
- PaddlePaddle: integrations/paddlepaddle.md
- Paperspace Gradient: integrations/paperspace.md
- Qualcomm QNN: integrations/qnn.md
- Ray Tune: integrations/ray-tune.md
- Roboflow: integrations/roboflow.md
- Rockchip RKNN: integrations/rockchip-rknn.md
- Seeed Studio reCamera: integrations/seeedstudio-recamera.md
- SONY IMX500: integrations/sony-imx500.md
- TensorBoard: integrations/tensorboard.md
- TensorRT: integrations/tensorrt.md
- TF GraphDef: integrations/tf-graphdef.md
- TF SavedModel: integrations/tf-savedmodel.md
- TF.js: integrations/tfjs.md
- TFLite: integrations/tflite.md
- TFLite Edge TPU: integrations/edge-tpu.md
- TorchScript: integrations/torchscript.md
- VS Code: integrations/vscode.md
- Weights & Biases: integrations/weights-biases.md
- Platform:
- Platform: platform/index.md
- Quickstart: platform/quickstart.md
- Data:
- platform/data/index.md
- Datasets: platform/data/datasets.md
- Annotation: platform/data/annotation.md
- Train:
- platform/train/index.md
- Projects: platform/train/projects.md
- Models: platform/train/models.md
- Cloud Training: platform/train/cloud-training.md
- Deploy:
- platform/deploy/index.md
- Inference: platform/deploy/inference.md
- Endpoints: platform/deploy/endpoints.md
- Monitoring: platform/deploy/monitoring.md
- Integrations:
- platform/integrations/index.md
- Ultralytics HUB: platform/integrations/ultralytics-hub.md
- Roboflow: platform/integrations/roboflow.md
- Account:
- platform/account/index.md
- API Keys: platform/account/api-keys.md
- Teams: platform/account/teams.md
- Billing: platform/account/billing.md
- Activity: platform/account/activity.md
- Trash: platform/account/trash.md
- Settings: platform/account/settings.md
- Explore: platform/explore.md
- REST API: platform/api/index.md
- Reference:
- reference/index.md
- __init__: reference/__init__.md
- cfg:
- __init__: reference/cfg/__init__.md
- data:
- annotator: reference/data/annotator.md
- augment: reference/data/augment.md
- base: reference/data/base.md
- build: reference/data/build.md
- converter: reference/data/converter.md
- dataset: reference/data/dataset.md
- loaders: reference/data/loaders.md
- split: reference/data/split.md
- split_dota: reference/data/split_dota.md
- utils: reference/data/utils.md
- engine:
- exporter: reference/engine/exporter.md
- model: reference/engine/model.md
- predictor: reference/engine/predictor.md
- results: reference/engine/results.md
- trainer: reference/engine/trainer.md
- tuner: reference/engine/tuner.md
- validator: reference/engine/validator.md
- hub:
- __init__: reference/hub/__init__.md
- auth: reference/hub/auth.md
- google:
- __init__: reference/hub/google/__init__.md
- session: reference/hub/session.md
- utils: reference/hub/utils.md
- models:
- fastsam:
- model: reference/models/fastsam/model.md
- predict: reference/models/fastsam/predict.md
- utils: reference/models/fastsam/utils.md
- val: reference/models/fastsam/val.md
- nas:
- model: reference/models/nas/model.md
- predict: reference/models/nas/predict.md
- val: reference/models/nas/val.md
- rtdetr:
- model: reference/models/rtdetr/model.md
- predict: reference/models/rtdetr/predict.md
- train: reference/models/rtdetr/train.md
- val: reference/models/rtdetr/val.md
- sam:
- amg: reference/models/sam/amg.md
- build: reference/models/sam/build.md
- build_sam3: reference/models/sam/build_sam3.md
- model: reference/models/sam/model.md
- modules:
- blocks: reference/models/sam/modules/blocks.md
- decoders: reference/models/sam/modules/decoders.md
- encoders: reference/models/sam/modules/encoders.md
- memory_attention: reference/models/sam/modules/memory_attention.md
- sam: reference/models/sam/modules/sam.md
- tiny_encoder: reference/models/sam/modules/tiny_encoder.md
- transformer: reference/models/sam/modules/transformer.md
- utils: reference/models/sam/modules/utils.md
- predict: reference/models/sam/predict.md
- sam3:
- decoder: reference/models/sam/sam3/decoder.md
- encoder: reference/models/sam/sam3/encoder.md
- geometry_encoders: reference/models/sam/sam3/geometry_encoders.md
- maskformer_segmentation: reference/models/sam/sam3/maskformer_segmentation.md
- model_misc: reference/models/sam/sam3/model_misc.md
- necks: reference/models/sam/sam3/necks.md
- sam3_image: reference/models/sam/sam3/sam3_image.md
- text_encoder_ve: reference/models/sam/sam3/text_encoder_ve.md
- vitdet: reference/models/sam/sam3/vitdet.md
- vl_combiner: reference/models/sam/sam3/vl_combiner.md
- utils:
- loss: reference/models/utils/loss.md
- ops: reference/models/utils/ops.md
- yolo:
- classify:
- predict: reference/models/yolo/classify/predict.md
- train: reference/models/yolo/classify/train.md
- val: reference/models/yolo/classify/val.md
- detect:
- predict: reference/models/yolo/detect/predict.md
- train: reference/models/yolo/detect/train.md
- val: reference/models/yolo/detect/val.md
- model: reference/models/yolo/model.md
- obb:
- predict: reference/models/yolo/obb/predict.md
- train: reference/models/yolo/obb/train.md
- val: reference/models/yolo/obb/val.md
- pose:
- predict: reference/models/yolo/pose/predict.md
- train: reference/models/yolo/pose/train.md
- val: reference/models/yolo/pose/val.md
- segment:
- predict: reference/models/yolo/segment/predict.md
- train: reference/models/yolo/segment/train.md
- val: reference/models/yolo/segment/val.md
- semantic:
- predict: reference/models/yolo/semantic/predict.md
- train: reference/models/yolo/semantic/train.md
- val: reference/models/yolo/semantic/val.md
- world:
- train: reference/models/yolo/world/train.md
- train_world: reference/models/yolo/world/train_world.md
- yoloe:
- predict: reference/models/yolo/yoloe/predict.md
- train: reference/models/yolo/yoloe/train.md
- train_seg: reference/models/yolo/yoloe/train_seg.md
- val: reference/models/yolo/yoloe/val.md
- nn:
- autobackend: reference/nn/autobackend.md
- backends:
- axelera: reference/nn/backends/axelera.md
- base: reference/nn/backends/base.md
- coreml: reference/nn/backends/coreml.md
- deepx: reference/nn/backends/deepx.md
- executorch: reference/nn/backends/executorch.md
- mnn: reference/nn/backends/mnn.md
- ncnn: reference/nn/backends/ncnn.md
- onnx: reference/nn/backends/onnx.md
- openvino: reference/nn/backends/openvino.md
- paddle: reference/nn/backends/paddle.md
- pytorch: reference/nn/backends/pytorch.md
- qnn: reference/nn/backends/qnn.md
- rknn: reference/nn/backends/rknn.md
- tensorflow: reference/nn/backends/tensorflow.md
- tensorrt: reference/nn/backends/tensorrt.md
- triton: reference/nn/backends/triton.md
- modules:
- activation: reference/nn/modules/activation.md
- block: reference/nn/modules/block.md
- conv: reference/nn/modules/conv.md
- head: reference/nn/modules/head.md
- transformer: reference/nn/modules/transformer.md
- utils: reference/nn/modules/utils.md
- tasks: reference/nn/tasks.md
- text_model: reference/nn/text_model.md
- optim:
- muon: reference/optim/muon.md
- solutions:
- ai_gym: reference/solutions/ai_gym.md
- analytics: reference/solutions/analytics.md
- config: reference/solutions/config.md
- distance_calculation: reference/solutions/distance_calculation.md
- heatmap: reference/solutions/heatmap.md
- instance_segmentation: reference/solutions/instance_segmentation.md
- object_blurrer: reference/solutions/object_blurrer.md
- object_counter: reference/solutions/object_counter.md
- object_cropper: reference/solutions/object_cropper.md
- parking_management: reference/solutions/parking_management.md
- queue_management: reference/solutions/queue_management.md
- region_counter: reference/solutions/region_counter.md
- security_alarm: reference/solutions/security_alarm.md
- similarity_search: reference/solutions/similarity_search.md
- solutions: reference/solutions/solutions.md
- speed_estimation: reference/solutions/speed_estimation.md
- streamlit_inference: reference/solutions/streamlit_inference.md
- trackzone: reference/solutions/trackzone.md
- vision_eye: reference/solutions/vision_eye.md
- trackers:
- basetrack: reference/trackers/basetrack.md
- bot_sort: reference/trackers/bot_sort.md
- byte_tracker: reference/trackers/byte_tracker.md
- track: reference/trackers/track.md
- utils:
- gmc: reference/trackers/utils/gmc.md
- kalman_filter: reference/trackers/utils/kalman_filter.md
- matching: reference/trackers/utils/matching.md
- utils:
- __init__: reference/utils/__init__.md
- autobatch: reference/utils/autobatch.md
- autodevice: reference/utils/autodevice.md
- benchmarks: reference/utils/benchmarks.md
- callbacks:
- base: reference/utils/callbacks/base.md
- clearml: reference/utils/callbacks/clearml.md
- comet: reference/utils/callbacks/comet.md
- dvc: reference/utils/callbacks/dvc.md
- hub: reference/utils/callbacks/hub.md
- mlflow: reference/utils/callbacks/mlflow.md
- neptune: reference/utils/callbacks/neptune.md
- platform: reference/utils/callbacks/platform.md
- raytune: reference/utils/callbacks/raytune.md
- tensorboard: reference/utils/callbacks/tensorboard.md
- wb: reference/utils/callbacks/wb.md
- checks: reference/utils/checks.md
- cpu: reference/utils/cpu.md
- dist: reference/utils/dist.md
- downloads: reference/utils/downloads.md
- errors: reference/utils/errors.md
- events: reference/utils/events.md
- export:
- axelera: reference/utils/export/axelera.md
- coreml: reference/utils/export/coreml.md
- deepx: reference/utils/export/deepx.md
- engine: reference/utils/export/engine.md
- executorch: reference/utils/export/executorch.md
- imx: reference/utils/export/imx.md
- mnn: reference/utils/export/mnn.md
- ncnn: reference/utils/export/ncnn.md
- onnx: reference/utils/export/onnx.md
- openvino: reference/utils/export/openvino.md
- paddle: reference/utils/export/paddle.md
- qnn: reference/utils/export/qnn.md
- rknn: reference/utils/export/rknn.md
- tensorflow: reference/utils/export/tensorflow.md
- torchscript: reference/utils/export/torchscript.md
- files: reference/utils/files.md
- git: reference/utils/git.md
- instance: reference/utils/instance.md
- logger: reference/utils/logger.md
- loss: reference/utils/loss.md
- metrics: reference/utils/metrics.md
- nms: reference/utils/nms.md
- ops: reference/utils/ops.md
- patches: reference/utils/patches.md
- plotting: reference/utils/plotting.md
- tal: reference/utils/tal.md
- torch_utils: reference/utils/torch_utils.md
- tqdm: reference/utils/tqdm.md
- triton: reference/utils/triton.md
- tuner: reference/utils/tuner.md
- uploads: reference/utils/uploads.md
- Help:
- Help: help/index.md
- Frequently Asked Questions (FAQ): help/FAQ.md
- Contributing Guide: help/contributing.md
- Continuous Integration (CI) Guide: help/CI.md
- Contributor License Agreement (CLA): help/CLA.md
- Minimum Reproducible Example (MRE) Guide: help/minimum-reproducible-example.md
- Code of Conduct: help/code-of-conduct.md
- Environmental, Health and Safety (EHS) Policy: help/environmental-health-safety.md
- Security Policy: help/security.md
- Privacy Policy: help/privacy.md
# Plugins --------------------------------------------------------------------------------------------------------------
plugins:
- search:
enabled: false
# Macros are handled by minijinja in build_docs.py
# - macros:
# include_yaml:
# - ultralytics/cfg/default.yaml
# Docstrings are rendered ahead of time via docs/build_reference.py (no mkdocstrings dependency)
# - mkdocstrings:
# enabled: true
# default_handler: python
# handlers:
# python:
# options:
# docstring_options:
# ignore_init_summary: true
# merge_init_into_class: true
# docstring_style: google
# show_root_heading: true
# show_source: true
# separate_signature: true
# line_length: 80
# show_signature_annotations: true
# show_symbol_type_heading: true # insiders
# show_symbol_type_toc: true # insiders
# show_inheritance_diagram: true # insiders
- ultralytics:
add_desc: False
add_image: True
add_authors: True
add_json_ld: True
add_share_buttons: True
add_css: False
default_image: https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png
default_author: glenn.jocher@ultralytics.com