Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify README.md #3530

Merged
merged 36 commits into from
Jun 13, 2021
Merged
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
f6633ca
Update README.md
kalenmike Jun 8, 2021
4b1deb3
added hosted images
kalenmike Jun 8, 2021
d13652e
added new logo
kalenmike Jun 8, 2021
48b1aff
testing image hosting
kalenmike Jun 8, 2021
7d14359
changed svgs to pngs
kalenmike Jun 8, 2021
c3eedd5
removed old header
kalenmike Jun 8, 2021
958171a
Update README.md
glenn-jocher Jun 8, 2021
6492050
correct colab image source
kalenmike Jun 8, 2021
fdc7154
splash.jpg
glenn-jocher Jun 9, 2021
bfd5578
rocket and W&B fix
glenn-jocher Jun 10, 2021
1e699d0
added contributing template
kalenmike Jun 11, 2021
a3164da
added social media to top section
kalenmike Jun 11, 2021
c321a99
increased size of top social media
kalenmike Jun 11, 2021
f35bda3
cleanup and updates
glenn-jocher Jun 12, 2021
9ef5ee9
rearrange quickstarts
glenn-jocher Jun 12, 2021
724f827
API cleanup
glenn-jocher Jun 12, 2021
f6a7144
PyTorch Hub cleanup
glenn-jocher Jun 12, 2021
e63b574
Add tutorials
glenn-jocher Jun 12, 2021
ec6ddbe
cleanup
glenn-jocher Jun 12, 2021
0f27fbe
update CONTRIBUTING.md
glenn-jocher Jun 12, 2021
a270f7d
Update README.md
glenn-jocher Jun 12, 2021
3cfa58f
update wandb link
glenn-jocher Jun 12, 2021
8ee1461
Update README.md
glenn-jocher Jun 12, 2021
2cb6635
remove tutorials header
glenn-jocher Jun 12, 2021
32055e7
update environments and integrations
glenn-jocher Jun 12, 2021
dc323b5
Comment API image
glenn-jocher Jun 12, 2021
42f898d
Update README.md
glenn-jocher Jun 12, 2021
1766dfc
Update README.md
glenn-jocher Jun 12, 2021
e059d1c
Update README.md
glenn-jocher Jun 12, 2021
591c4fe
Update README.md
glenn-jocher Jun 12, 2021
4de5012
Update README.md
glenn-jocher Jun 12, 2021
ad8a50f
double spaces after section
glenn-jocher Jun 12, 2021
5b429f8
Merge remote-tracking branch 'origin/KalenMike-readme-update' into Ka…
glenn-jocher Jun 12, 2021
90b71ca
Merge branch 'master' into KalenMike-readme-update
glenn-jocher Jun 12, 2021
7f04ca0
Update README.md
glenn-jocher Jun 12, 2021
cdf62c2
Update README.md
glenn-jocher Jun 12, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
rearrange quickstarts
  • Loading branch information
glenn-jocher committed Jun 12, 2021
commit 9ef5ee92290a5c34d93b76e23e655a3fdc37403f
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,69 +63,69 @@ See the [YOLOv5 Docs](https://docs.ultralytics.com) for full documentation on tr
These tutorials are intended to get you started using YOLOv5 quickly for demonstration purposes.
Head to the [YOLOv5 Docs](https://docs.ultralytics.com) for more in-depth details.

<details>
<details open>
<summary>
Install Locally
Install
</summary>

```bash
$ git clone https://github.com/ultralytics/yolov5
$ pip install -r requirements.txt
```

</details>
<details>
<summary>Inference Using Repository Clone</summary>

_NOTE : In order to follow this tutorial please ensure you have installed YOLOv5 locally._

```bash
# Run inference based on selected input
$ python detect.py --source 0 # webcam
file.jpg # image
file.mp4 # video
path/ # directory
path/*.jpg # glob
'https://youtu.be/NUsoVlDFqZg' # YouTube video
'rtsp://example.com/media.mp4' # RTSP, RTMP, HTTP stream
```

</details>
<details open>
<summary>Inference Using PyTorch Hub</summary>
<summary>Inference</summary>

This tutorial will automatically download YOLOv5 models before running inference on the supplied image.

```python
import torch

# Load a model
model = torch.hub.load('ultralytics/yolov5', 'yolov5s') # or yolov5m, yolov5l, yolov5x
# Model
model = torch.hub.load('ultralytics/yolov5', 'yolov5s') # or yolov5m, yolov5x, custom

# Define images
img = 'https://ultralytics.com/images/zidane.jpg'
# Images
img = 'https://ultralytics.com/images/zidane.jpg' # or file, PIL, OpenCV, numpy, multiple

# Run inference
# Inference
results = model(img)

# Handle results
results.print() # or .show(), .save(), .pandas().xyz()
# Results
results.print() # or .show(), .save(), .crop(), .pandas(), etc.
```

</details>



<details>
<summary>Inference with detect.py</summary>

`detect.py` runs inference on a variety of sources, downloading models automatically from the [latest YOLOv5 release](https://github.com/ultralytics/yolov5/releases) and saving results to `runs/detect`.
```bash
$ python detect.py --source 0 # webcam
file.jpg # image
file.mp4 # video
path/ # directory
path/*.jpg # glob
'https://youtu.be/NUsoVlDFqZg' # YouTube video
'rtsp://example.com/media.mp4' # RTSP, RTMP, HTTP stream
```

</details>

<details>
<summary>Training</summary>

_NOTE : In order to follow this tutorial please ensure you have installed YOLOv5 locally._

Run commands below to reproduce results on [COCO](https://github.com/ultralytics/yolov5/blob/master/data/scripts/get_coco.sh) dataset (dataset auto-downloads on first use). Training times for YOLOv5s/m/l/x are 2/4/6/8 days on a single V100 (multi-GPU times faster). Use the largest `--batch-size` your GPU allows (batch sizes shown for 16 GB devices).
```bash
$ python train.py --data coco.yaml --cfg yolov5s.yaml --weights '' --batch-size 64
yolov5m 40
yolov5l 24
yolov5x 16

```
<img width="800" src="https://user-images.githubusercontent.com/26833433/90222759-949d8800-ddc1-11ea-9fa1-1c97eed2b963.png">

</details>

Expand Down