Skip to content

Commit

Permalink
Updates to README
Browse files Browse the repository at this point in the history
  • Loading branch information
David Hovstadius committed Oct 24, 2024
1 parent b2a0454 commit 0a319a2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,16 +97,18 @@ For getting started quickly, you can navigate into the `examples` repository to
## Step 5: Setting up configurations

### Number of classes
To set up your Ultralytics model, you need to adjust the configuration files. Specifically, the number of classes (nc) must be set in both the `data.yaml` and the `yolov8_.yaml` files. Make sure to update these files with the appropriate number of classes for your specific dataset.
To set up your YOLOv8 model, you need to adjust the configuration files. Specifically, the number of classes (nc) must be set in both the `data.yaml` and the `yolov8_.yaml` files inside the 'clients' folder. Make sure to update these files with the appropriate number of classes for your specific dataset.

### Size of the model
### Size of the YOLOv8 model
You also need to select which YOLOv8 model to use by renaming the `yolov8_.yaml` file according to the desired model variant:
- For YOLOv8n (nano), rename the file to `yolov8n.yaml`
- For YOLOv8s (small), rename the file to `yolov8s.yaml`
- For YOLOv8m (medium), rename the file to `yolov8m.yaml`
- For YOLOv8l (large), rename the file to `yolov8l.yaml`
- For YOLOv8x (extra large), rename the file to `yolov8x.yaml`

If no specific model is selected, the default model is YOLOv8n.

### Local client configurations
Each client can set different training configurations in the `client_config.yaml` file. This file contains the configurations for the client environments, such as the number of local epochs, and batch size. You can adjust these configurations to suit each client's hardware and training requirements.

Expand Down

0 comments on commit 0a319a2

Please sign in to comment.