Skip to content

Commit 7246d2e

Browse files
committed
docs(ml): add venv setup and main.py usage to yolo_toolkit README
1 parent 238c328 commit 7246d2e

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

yolo_toolkit/README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,53 @@ This is a specialized training suite designed for high-precision traffic sign de
77
- **Decoupled Configuration**: All training parameters (learning rate, mosaic, batch size) are controlled via `configs/hyperparameters.yaml`**never touch the code**.
88
- **Quantization Ready**: The pipeline is pre-configured to export models optimized for the Jetson Nano's TensorRT engines.
99

10-
## 🛠️ Usage
10+
## 🛠️ Setup & Installation
1111

12-
### 1. Requirements
13-
Ensure you are in a Python 3.10+ environment with CUDA available.
12+
Follow these steps to set up an isolated training environment on your PC (Windows or Linux).
13+
14+
### 1. Create Virtual Environment
15+
```bash
16+
# Navigate to the toolkit directory
17+
cd yolo_toolkit
18+
19+
# Create the venv
20+
python -m venv venv
21+
```
22+
23+
### 2. Activate Environment
24+
**Windows:**
25+
```bash
26+
.\venv\Scripts\activate
27+
```
28+
**Linux / macOS:**
1429
```bash
15-
pip install -r yolo_toolkit/requirements.txt
30+
source venv/bin/activate
1631
```
1732

18-
### 2. Training
19-
Adjust your settings in `yolo_toolkit/configs/hyperparameters.yaml` and then run:
33+
### 3. Install Expert Dependencies
34+
```bash
35+
# Upgrade pip first
36+
python -m pip install --upgrade pip
37+
38+
# Install requirements
39+
pip install -r requirements.txt
40+
```
41+
42+
---
43+
44+
## 🚀 Execution Guide
45+
Adjust your settings in `configs/hyperparameters.yaml` and then run:
46+
47+
### 1. Training
2048
```bash
21-
python yolo_toolkit/core/train_yolo.py --data dataset/data.yaml
49+
python main.py train
2250
```
23-
Output models will appear in `yolo_toolkit/outputs/jetracer_hardened/`.
51+
Output models will appear in `outputs/jetracer_hardened/`.
2452

25-
### 3. Export for Jetson
53+
### 2. Export for Jetson
2654
Convert your best model to a high-speed FP16 `.engine` file:
2755
```bash
28-
python yolo_toolkit/core/export_yolo.py --weights yolo_toolkit/outputs/jetracer_hardened/weights/best.pt --half
56+
python main.py export --weights outputs/jetracer_hardened/weights/best.pt
2957
```
3058

3159
---

0 commit comments

Comments
 (0)