3.1 KiB
CLI Basics
If you want to train, validate or run inference on models and don't need to make any modifications to the code, using YOLO command line interface is the easiest way to get started.
!!! tip "Syntax"
bash yolo task=detect mode=train model=yolov8n.yaml epochs=1 ... ... ... ... segment predict yolov8n-seg.pt classify val yolov8n-cls.pt
The experiment arguments can be overridden directly by pass arg=val
covered in the next section. You can run any supported task by setting task
and mode
in cli.
=== "Training"
task |
snippet | |
---|---|---|
Detection | detect |
|
Instance Segment | segment |
|
Classification | classify |
|
=== "Prediction"
task |
snippet | |
---|---|---|
Detection | detect |
|
Instance Segment | segment |
|
Classification | classify |
|
=== "Validation"
task |
snippet | |
---|---|---|
Detection | detect |
|
Instance Segment | segment |
|
Classification | classify |
|
!!! note ""
Note: The arguments don't require '--'
prefix. These are reserved for special commands covered later
Overriding default config arguments
All global default arguments can be overriden by simply passing them as arguments in the cli.
!!! tip ""
=== "Syntax"
yolo task= ... mode= ... {++ arg=val ++}
=== "Example"
Perform detection training for `10 epochs` with `learning_rate` of `0.01`
```
yolo task=detect mode=train {++ epochs=10 lr0=0.01 ++}
```
Overriding default config file
You can override config file entirely by passing a new file. You can create a copy of default config file in your current working dir as follows:
yolo task=init
You can then use cfg=name.yaml
command to pass the new config file
yolo cfg=default.yaml
??? example
=== "Command"
yolo task=init yolo cfg=default.yaml
=== "Result"
TODO: add terminal output