Tạo ví dụ tối thiểu có thể tái hiện để báo cáo lỗi#

Khi gửi báo cáo lỗi cho các kho lưu trữ Ultralytics YOLO, bạn cần cung cấp một Ví dụ tối thiểu có thể tái hiện (MRE). MRE là một đoạn mã nhỏ, độc lập, thể hiện vấn đề bạn gặp phải. Cung cấp MRE giúp người duy trì dự án và người đóng góp hiểu vấn đề, đồng thời xử lý lỗi hiệu quả hơn. Hướng dẫn này giải thích cách tạo MRE khi gửi báo cáo lỗi cho các kho lưu trữ Ultralytics YOLO.

1. Cô lập vấn đề#

Bước đầu tiên để tạo MRE là cô lập vấn đề. Loại bỏ mọi mã hoặc phần phụ thuộc không liên quan trực tiếp đến vấn đề. Tập trung vào phần cụ thể của mã gây ra vấn đề và loại bỏ mọi phần không liên quan.

2. Sử dụng model và tập dữ liệu công khai#

Khi tạo MRE, hãy sử dụng model và tập dữ liệu có sẵn công khai để tái hiện vấn đề. Ví dụ: sử dụng model yolo26n.pt và tập dữ liệu coco8.yaml. Điều này đảm bảo người duy trì dự án và người đóng góp có thể dễ dàng chạy ví dụ của bạn và điều tra vấn đề mà không cần truy cập dữ liệu độc quyền hoặc model tùy chỉnh.

3. Bao gồm mọi phần phụ thuộc cần thiết#

Đảm bảo MRE của bạn bao gồm mọi phần phụ thuộc cần thiết. Nếu mã của bạn dựa vào thư viện bên ngoài, hãy nêu rõ các gói cần thiết và phiên bản của chúng. Tốt nhất, hãy liệt kê các phần phụ thuộc trong báo cáo lỗi bằng yolo checks nếu bạn đã cài đặt ultralytics, hoặc bằng pip list đối với các công cụ khác.

4. Mô tả vấn đề rõ ràng#

Mô tả rõ ràng và ngắn gọn vấn đề bạn gặp phải. Giải thích hành vi dự kiến và hành vi thực tế bạn đang gặp. Nếu phù hợp, hãy đưa vào các thông báo lỗi hoặc log liên quan.

5. Định dạng mã đúng cách#

Định dạng mã đúng cách bằng các khối mã trong phần mô tả issue. Cách này giúp người khác đọc và hiểu mã của bạn dễ dàng hơn. Trên GitHub, bạn có thể tạo khối mã bằng cách đặt mã giữa ba dấu backtick (```) và chỉ định ngôn ngữ:

```python
# Your Python code goes here
```

6. Kiểm tra MRE#

Trước khi gửi MRE, hãy kiểm tra để đảm bảo MRE tái hiện chính xác vấn đề. Đảm bảo người khác có thể chạy ví dụ của bạn mà không gặp vấn đề hoặc cần chỉnh sửa.

Ví dụ về MRE#

Sau đây là ví dụ về MRE cho một báo cáo lỗi giả định:

Mô tả lỗi:

Khi chạy inference trên ảnh có 0 kênh, tôi gặp lỗi liên quan đến kích thước của tensor đầu vào.

MRE:

import torch

from ultralytics import YOLO

# Tải model
model = YOLO("yolo26n.pt")

# Tải ảnh có 0 kênh
image = torch.rand(1, 0, 640, 640)

# Chạy model
results = model(image)

Thông báo lỗi:

RuntimeError: Expected input[1, 0, 640, 640] to have 3 channels, but got 0 channels instead

Phần phụ thuộc:

• torch==2.8.0
• ultralytics==8.4.142

Trong ví dụ này, MRE thể hiện vấn đề bằng lượng mã tối thiểu, sử dụng model công khai ("yolo26n.pt"), bao gồm mọi phần phụ thuộc cần thiết và mô tả rõ vấn đề kèm thông báo lỗi.

Bằng cách làm theo các hướng dẫn này, bạn sẽ giúp người duy trì dự án và người đóng góp cho các kho lưu trữ Ultralytics YOLO hiểu và xử lý vấn đề của bạn hiệu quả hơn.

Câu hỏi thường gặp#