docs setup (#61)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Ayush Chaurasia 2022-12-05 06:04:57 +05:30 committed by GitHub
parent 7ec7cf3aef
commit fe75a9ce67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 258 additions and 3 deletions

45
docs/quickstart.md Normal file
View file

@ -0,0 +1,45 @@
## Installation
!!! note "Latest Stable Release"
```
pip install ultralytics
```
??? tip "Development and Contributing"
```
git clone https://github.com/ultralytics/ultralytics
cd ultralytics
pip install -e '.[dev]'
```
See contributing section to know more about contributing to the project
## CLI
The command line YOLO interface let's you simply train, validate or infer models on various tasks and versions.
CLI requires no customization or code. You can simply run all tasks from the terminal
!!! tip
=== "Syntax"
```bash
yolo task=detect mode=train model=s.yaml epochs=1 ...
... ... ...
segment infer s-cls.pt
classify val s-seg.pt
```
=== "Example"
```bash
yolo task=detect mode=val model=s.yaml
```
TODO: add terminal screen/gif
[CLI Guide](#){ .md-button .md-button--primary}
## Python API
Ultralytics YOLO comes with pythonic Model and Trainer interface.
!!! tip
```python
import ultralytics
from ultralytics import YOLO
model = YOLO()
model.new("s-seg.yaml") # automatically detects task type
model.load("s-seg.pt") # load checkpoint
model.train(data="coco128-segments", epochs=1, lr0=0.01, ...)
```
[API Guide](#){ .md-button .md-button--primary}