Skip to content

Commit 5cc30d7

Browse files
committed
Address review: clarify CI smoke-test scope, exp<N> increment, family-link guidance
1 parent b01fee9 commit 5cc30d7

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ After opening a PR:
3535
```bash
3636
uv pip install -r requirements.txt # install (never bare pip install)
3737

38-
# There is no pytest suite. CI smoke-tests the real scripts (source of truth:
39-
# .github/workflows/ci-testing.yml); the fast local equivalent is:
38+
# There is no pytest suite. CI smoke-tests the real scripts; the full loop (val/detect on both
39+
# official and trained weights, plus torch.hub custom-load traces) is in .github/workflows/ci-testing.yml.
40+
# Fast local subset — train auto-increments runs/train/exp<N>, so point val at the run just created:
4041
python train.py --imgsz 64 --batch 32 --weights yolov3-tiny.pt --cfg yolov3-tiny.yaml --epochs 1 --device cpu
4142
python val.py --imgsz 64 --batch 32 --weights runs/train/exp/weights/best.pt --device cpu
4243
python detect.py --imgsz 64 --weights yolov3-tiny.pt --device cpu
@@ -65,4 +66,4 @@ Pretrained weights download from the GitHub release `v9.6.0` assets via `utils/d
6566
- The CI smoke tests hit the live network: they download `yolov3-tiny.pt` from the v9.6.0 release and the coco128 dataset from `github.com/ultralytics/assets`.
6667
- Keep `requirements.txt` and `pyproject.toml` dependency floors aligned — Dependabot bumps both (monthly pip, weekly github-actions).
6768
- Links to `github.com/ultralytics/yolov5/(issues|pull|discussions)/<N>` are intentional upstream provenance — do not rewrite them to `yolov3` (those numbers 404 there). Bare yolov5 repo/tree/releases links were already rebranded.
68-
- README, docstrings, and tutorial content must stay evergreen and YOLOv3-focused: historical facts are fine, but no "latest/NEW/SOTA" promo for other models and at most one version-less pointer to `github.com/ultralytics/ultralytics`.
69+
- README, docstrings, and tutorial content must stay evergreen and YOLOv3-focused: historical facts are fine, but no "latest/NEW/SOTA" promo for other models — reference the broader family only via version-less `github.com/ultralytics/ultralytics` pointers.

0 commit comments

Comments
 (0)