Mkdocs annotations fixes (#7600)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Glenn Jocher 2024-01-15 23:37:37 +01:00 committed by GitHub
parent 22651d01cf
commit b1282544d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 137 additions and 63 deletions

View file

@ -193,18 +193,21 @@ Default arguments can be overridden by simply passing them as arguments in the C
!!! Tip ""
=== "Train"
Train a detection model for `10 epochs` with `learning_rate` of `0.01`
```bash
yolo detect train data=coco128.yaml model=yolov8n.pt epochs=10 lr0=0.01
```
=== "Predict"
Predict a YouTube video using a pretrained segmentation model at image size 320:
```bash
yolo segment predict model=yolov8n-seg.pt source='https://youtu.be/LNwODJXcvt4' imgsz=320
```
=== "Val"
Validate a pretrained detection model at batch-size 1 and image size 640:
```bash
yolo detect val model=yolov8n.pt data=coco128.yaml batch=1 imgsz=640
@ -221,6 +224,7 @@ This will create `default_copy.yaml`, which you can then pass as `cfg=default_co
!!! Example
=== "CLI"
```bash
yolo copy-cfg
yolo cfg=default_copy.yaml imgsz=320

View file

@ -52,6 +52,7 @@ Train mode is used for training a YOLOv8 model on a custom dataset. In this mode
!!! Example "Train"
=== "From pretrained(recommended)"
```python
from ultralytics import YOLO
@ -60,6 +61,7 @@ Train mode is used for training a YOLOv8 model on a custom dataset. In this mode
```
=== "From scratch"
```python
from ultralytics import YOLO
@ -68,6 +70,7 @@ Train mode is used for training a YOLOv8 model on a custom dataset. In this mode
```
=== "Resume"
```python
model = YOLO("last.pt")
results = model.train(resume=True)
@ -82,6 +85,7 @@ Val mode is used for validating a YOLOv8 model after it has been trained. In thi
!!! Example "Val"
=== "Val after training"
```python
from ultralytics import YOLO
@ -91,6 +95,7 @@ Val mode is used for validating a YOLOv8 model after it has been trained. In thi
```
=== "Val independently"
```python
from ultralytics import YOLO
@ -110,6 +115,7 @@ Predict mode is used for making predictions using a trained YOLOv8 model on new
!!! Example "Predict"
=== "From source"
```python
from ultralytics import YOLO
from PIL import Image
@ -133,6 +139,7 @@ Predict mode is used for making predictions using a trained YOLOv8 model on new
```
=== "Results usage"
```python
# results would be a list of Results object including all the predictions by default
# but be careful as it could occupy a lot memory when there're many images,