basharbme / hub-1

Ultralytics HUB tutorials and support

👋 Hello from the Ultralytics Team! We've been working hard these last few months to launch Ultralytics HUB, a new web tool for training and deploying all your YOLOv5 and YOLOv8 🚀 models from one spot!

We hope that the resources here will help you get the most out of HUB. Please browse the HUB Docs for details, raise an issue on GitHub for support, and join our Discord community for questions and discussions!

1. Upload a Dataset

Ultralytics HUB datasets are just like YOLOv5 and YOLOv8 🚀 datasets, they use the same structure and the same label formats to keep everything simple.

When you upload a dataset to Ultralytics HUB, make sure to place your dataset YAML inside the dataset root directory as in the example shown below, and then zip for upload to https://hub.ultralytics.com. Your dataset YAML, directory and zip should all share the same name. For example, if your dataset is called 'coco8' as in our example ultralytics/hub/example_datasets/coco8.zip, then you should have a coco8.yaml inside your coco8/ directory, which should zip to create coco8.zip for upload:

zip -r coco8.zip coco8

The example_datasets/coco8.zip dataset in this repository can be downloaded and unzipped to see exactly how to structure your custom dataset.

The dataset YAML is the same standard YOLOv5 and YOLOv8 YAML format. See the YOLOv5 and YOLOv8 Train Custom Data tutorial for full details.

# Train/val/test sets as 1) dir: path/to/imgs, 2) file: path/to/imgs.txt, or 3) list: [path/to/imgs1, path/to/imgs2, ..]
path:  # dataset root dir (leave empty for HUB)
train: images/train  # train images (relative to 'path') 8 images
val: images/val  # val images (relative to 'path') 8 images
test:  # test images (optional)

# Classes
names:
  0: person
  1: bicycle
  2: car
  3: motorcycle
  ...

After zipping your dataset, sign in to Ultralytics HUB and click the Datasets tab. Click 'Upload Dataset' to upload, scan and visualize your new dataset before training new YOLOv5 or YOLOv8 models on it!

2. Train a Model

Connect to the Ultralytics HUB notebook and use your model API key to begin training!

3. Deploy to Real World

Export your model to 13 different formats, including TensorFlow, ONNX, OpenVINO, CoreML, Paddle and many others. Run models directly on your iOS or Android mobile device by downloading the Ultralytics App!

❓ Issues

If you are a new Ultralytics HUB user and have questions or comments, you are in the right place! Please click the New Issue button in the Issues tab in this repo and let us know what we can do to make your life better 😃!