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.
175 lines
5.2 KiB
175 lines
5.2 KiB
# Ultralytics YOLO 🚀, AGPL-3.0 license |
|
|
|
site_name: YOLOv8 Docs |
|
repo_url: https://github.com/ultralytics/ultralytics |
|
edit_uri: https://github.com/ultralytics/ultralytics/tree/main/docs |
|
repo_name: ultralytics/ultralytics |
|
remote_name: https://github.com/ultralytics/docs |
|
|
|
theme: |
|
name: "material" |
|
logo: https://github.com/ultralytics/assets/raw/main/logo/Ultralytics_Logotype_Reverse.svg |
|
favicon: assets/favicon.ico |
|
font: |
|
text: Roboto |
|
code: Roboto Mono |
|
|
|
palette: |
|
# Palette toggle for light mode |
|
- scheme: default |
|
# primary: grey |
|
toggle: |
|
icon: material/brightness-7 |
|
name: Switch to dark mode |
|
|
|
# Palette toggle for dark mode |
|
- scheme: slate |
|
# primary: black |
|
toggle: |
|
icon: material/brightness-4 |
|
name: Switch to light mode |
|
features: |
|
- content.action.edit |
|
- content.code.annotate |
|
- content.code.copy |
|
- content.tooltips |
|
- search.highlight |
|
- search.share |
|
- search.suggest |
|
- toc.follow |
|
- navigation.top |
|
- navigation.expand |
|
- navigation.footer |
|
- navigation.tracking |
|
- navigation.instant |
|
- navigation.indexes |
|
- content.tabs.link # all code tabs change simultaneously |
|
|
|
# Customization |
|
copyright: <a href="https://ultralytics.com" target="_blank">Ultralytics 2023.</a> All rights reserved. |
|
extra: |
|
# version: |
|
# provider: mike # version drop-down menu |
|
analytics: |
|
provider: google |
|
property: G-2M5EHKC0BH |
|
feedback: |
|
title: Was this page helpful? |
|
ratings: |
|
- icon: material/heart |
|
name: This page was helpful |
|
data: 1 |
|
note: Thanks for your feedback! |
|
- icon: material/heart-broken |
|
name: This page could be improved |
|
data: 0 |
|
note: >- |
|
Thanks for your feedback!<br> |
|
<a href="https://github.com/ultralytics/ultralytics/issues/new?title=Docs+Feedback+for+{title}+page+at+https://docs.ultralytics.com/{url}&labels=enhancement&template=feature-request.yml" target="_blank" rel="noopener">Tell us what we can improve.</a> |
|
|
|
social: |
|
- icon: fontawesome/brands/github |
|
link: https://github.com/ultralytics |
|
- icon: fontawesome/brands/linkedin |
|
link: https://www.linkedin.com/company/ultralytics/ |
|
- icon: fontawesome/brands/twitter |
|
link: https://twitter.com/ultralytics |
|
- icon: fontawesome/brands/youtube |
|
link: https://www.youtube.com/ultralytics |
|
- icon: fontawesome/brands/docker |
|
link: https://hub.docker.com/r/ultralytics/ultralytics/ |
|
- icon: fontawesome/brands/python |
|
link: https://pypi.org/project/ultralytics/ |
|
|
|
extra_css: |
|
- stylesheets/style.css |
|
|
|
markdown_extensions: |
|
# Div text decorators |
|
- admonition |
|
- md_in_html |
|
- pymdownx.details |
|
- pymdownx.superfences |
|
- tables |
|
- attr_list |
|
- def_list |
|
# Syntax highlight |
|
- pymdownx.highlight: |
|
anchor_linenums: true |
|
- pymdownx.inlinehilite |
|
- pymdownx.snippets |
|
- pymdownx.emoji: |
|
emoji_index: !!python/name:materialx.emoji.twemoji # noqa |
|
emoji_generator: !!python/name:materialx.emoji.to_svg |
|
|
|
# Content tabs |
|
- pymdownx.tabbed: |
|
alternate_style: true |
|
|
|
# Highlight |
|
- pymdownx.critic |
|
- pymdownx.caret |
|
- pymdownx.keys |
|
- pymdownx.mark |
|
- pymdownx.tilde |
|
|
|
plugins: |
|
- mkdocstrings |
|
- search |
|
|
|
# Primary navigation |
|
nav: |
|
- Home: index.md |
|
- Quickstart: quickstart.md |
|
- 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 |
|
- Classify: tasks/classify.md |
|
- Pose: tasks/pose.md |
|
- Usage: |
|
- CLI: usage/cli.md |
|
- Python: usage/python.md |
|
- Callbacks: usage/callbacks.md |
|
- Configuration: usage/cfg.md |
|
- Advanced Customization: usage/engine.md |
|
- Ultralytics HUB: hub.md |
|
- iOS and Android App: app.md |
|
- Reference: |
|
- Engine: |
|
- Model: reference/model.md |
|
- Trainer: reference/base_trainer.md |
|
- Validator: reference/base_val.md |
|
- Predictor: reference/base_pred.md |
|
- Exporter: reference/exporter.md |
|
- Results: reference/results.md |
|
- ultralytics.nn: reference/nn.md |
|
- Operations: reference/ops.md |
|
- YOLOv5: |
|
- yolov5/index.md |
|
- Train Custom Data: yolov5/train_custom_data.md |
|
- Tips for Best Training Results: yolov5/tips_for_best_training_results.md |
|
- Multi-GPU Training: yolov5/multi_gpu_training.md |
|
- PyTorch Hub: yolov5/pytorch_hub.md |
|
- TFLite, ONNX, CoreML, TensorRT Export: yolov5/export.md |
|
- NVIDIA Jetson Nano Deployment: yolov5/jetson_nano.md |
|
- Test-Time Augmentation (TTA): yolov5/tta.md |
|
- Model Ensembling: yolov5/ensemble.md |
|
- Pruning/Sparsity Tutorial: yolov5/pruning_sparsity.md |
|
- Hyperparameter evolution: yolov5/hyp_evolution.md |
|
- Transfer learning with frozen layers: yolov5/transfer_learn_frozen.md |
|
- Architecture Summary: yolov5/architecture.md |
|
- Roboflow Datasets: yolov5/roboflow.md |
|
- Neural Magic's DeepSparse: yolov5/neural_magic.md |
|
- Comet Logging: yolov5/comet.md |
|
- Clearml Logging: yolov5/clearml.md |
|
|
|
- Security: SECURITY.md
|
|
|