You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

100 lines
2.3 KiB

site_name: Ultralytics YOLO Docs
repo_url: https://github.com/ultralytics/yolov5
repo_name: Ultralytics
theme:
name: "material"
logo: assets/logo.png
icon:
repo: fontawesome/brands/github
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.annotate
- content.tooltips
- search.highlight
- search.share
- search.suggest
- toc.follow
extra_css:
- stylesheets/style.css
markdown_extensions:
# Div text decorators
- admonition
- pymdownx.details
- pymdownx.superfences
- tables
- attr_list
- def_list
# Syntax highlight
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
# Button
- attr_list
# Content tabs
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# Highlight
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
plugins:
- mkdocstrings
# Primary navigation
nav:
- Quickstart: quickstart.md
- CLI: cli.md
- Python Interface: sdk.md
- Configuration: config.md
- Tasks:
- Detection: tasks/detection.md
- Segmentation: tasks/segmentation.md
- Classification: tasks/classification.md
- Advanced Tutorials:
- Customize Trainer: customize/train.md
- Customize Validator: customize/val.md
- Customize Predictor: customize/predict.md
- Reference:
- Python Model interface: reference/model.md
- Engine:
- Trainer: reference/base_trainer.md
- Validator: reference/base_val.md
- Predictor: reference/base_pred.md
- Exporter: reference/exporter.md
- nn Module: reference/nn.md
- operations: reference/ops.md