Tạo một ví dụ có thể tái tạo tối thiểu cho báo cáo lỗi trong Ultralytics YOLO Kho lưu trữ

Q: What are some common errors to check before submitting my MRE for a bug report?

Trước khi nộp bài kiểm tra MRE, hãy đảm bảo: Để biết danh sách kiểm tra chi tiết, hãy truy cập phần Kiểm tra MRE của bạn.

Khi gửi báo cáo lỗi cho kho lưu trữ YOLO Ultralytics , điều cần thiết là phải cung cấp Ví dụ có thể tái tạo tối thiểu (MRE) . MRE là một đoạn mã nhỏ, độc lập, minh họa vấn đề bạn đang gặp phải. Việc cung cấp MRE giúp người bảo trì và người đóng góp hiểu được vấn đề và làm việc để sửa 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 tới Ultralytics YOLO kho lưu trữ.

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

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

2. Sử dụng Mô hình và Bộ dữ liệu công khai

Khi tạo MRE, hãy sử dụng các mô hình và tập dữ liệu có sẵn công khai để tái tạo vấn đề. Ví dụ: sử dụng yolov8n.pt mô hình và coco8.yaml bộ dữ liệu. Điều này đảm bảo rằng người bảo trì 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 vào dữ liệu độc quyền hoặc mô hình tùy chỉnh.

3. Bao gồm tất cả các phụ thuộc cần thiết

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

4. Viết mô tả rõ ràng về vấn đề

Cung cấp mô tả rõ ràng và súc tích về sự cố bạn đang 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 phải. Nếu có thể, hãy bao gồm bất kỳ thông báo lỗi hoặc nhật ký nào có liên quan.

5. Định dạng mã của bạn đúng cách

Định dạng mã của bạn đúng cách bằng cách sử dụng các khối mã trong mô tả sự cố. Điều này giúp người khác dễ đọc và hiểu mã của bạn hơn. Trong GitHub, bạn có thể tạo một khối mã bằng cách bao bọc mã của mình bằng ba dấu ngoặc ngược (```) và chỉ định ngôn ngữ:

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

6. Kiểm tra MRE của bạn

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

Ví dụ về MRE

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

Mô tả lỗi:

Khi chạy suy luận trên hình ảnh kênh 0, tôi nhận được lỗi liên quan đến kích thước của đầu vào tensor .

GIÁO DỤC VÀ ĐÀO TẠO (MRE):

import torch

from ultralytics import YOLO

# Load the model
model = YOLO("yolov8n.pt")

# Load a 0-channel image
image = torch.rand(1, 0, 640, 640)

# Run the 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ụ thuộc:

torch==2.3.0
ultralytics==8.2.0

Trong ví dụ này, MRE chứng minh vấn đề bằng một lượng mã tối thiểu, sử dụng một mô hình công khai ("yolov8n.pt"), bao gồm tất cả các phụ thuộc cần thiết và cung cấp mô tả rõ ràng về vấn đề cùng với thông báo lỗi.

Bằng cách tuân theo các hướng dẫn này, bạn sẽ giúp những người bảo trì và đóng góp Ultralytics YOLO kho lưu trữ để hiểu và giải quyết vấn đề của bạn hiệu quả hơn.

CÂU HỎI THƯỜNG GẶP

Làm thế nào để tôi tạo một Ví dụ có thể tái tạo tối thiểu (MRE) hiệu quả cho các báo cáo lỗi trong Ultralytics YOLO kho lưu trữ?

Để tạo ra một Ví dụ có thể tái tạo tối thiểu (MRE) hiệu quả cho các báo cáo lỗi trong Ultralytics YOLO kho lưu trữ, hãy làm theo các bước sau:

Xác định vấn đề : Xóa bất kỳ mã hoặc phần phụ thuộc nào không liên quan trực tiếp đến vấn đề.
Sử dụng các mô hình và bộ dữ liệu công khai: Sử dụng các nguồn lực công cộng như yolov8n.pt Và coco8.yaml để dễ tái tạo hơn.
Bao gồm tất cả các phụ thuộc cần thiết: Chỉ định các gói cần thiết và phiên bản của chúng. Bạn có thể liệt kê các phụ thuộc bằng cách sử dụng yolo checks nếu bạn có ultralytics đã cài đặt hoặc pip list.
Viết mô tả rõ ràng về vấn đề : Giải thích hành vi dự kiến và thực tế, bao gồm mọi thông báo lỗi hoặc nhật ký.
Định dạng mã của bạn đúng cách : Sử dụng các khối mã để định dạng mã của bạn, giúp mã dễ đọc hơn.
Kiểm tra MRE của bạn : Đảm bảo MRE của bạn tái tạo được sự cố mà không cần chỉnh sửa.

Để biết hướng dẫn chi tiết, hãy xem mục Tạo ví dụ có thể tái tạo tối thiểu .

Tại sao tôi nên sử dụng các mô hình và tập dữ liệu có sẵn công khai trong MRE của mình? Ultralytics YOLO báo cáo lỗi?

Sử dụng các mô hình và tập dữ liệu có sẵn công khai trong MRE của bạn đảm bảo rằng người bảo trì có thể dễ dàng chạy ví dụ của bạn mà không cần truy cập vào dữ liệu độc quyền. Điều này cho phép giải quyết vấn đề nhanh hơn và hiệu quả hơn. Ví dụ, sử dụng yolov8n.pt mô hình và coco8.yaml bộ dữ liệu giúp chuẩn hóa và đơn giản hóa quá trình gỡ lỗi. Tìm hiểu thêm về các mô hình và bộ dữ liệu công khai trong Sử dụng các mô hình và bộ dữ liệu công khai phần.

Tôi nên đưa thông tin gì vào báo cáo lỗi của mình? Ultralytics YOLO ?

Một báo cáo lỗi toàn diện cho Ultralytics YOLO nên bao gồm:

Mô tả rõ ràng : Giải thích vấn đề, hành vi mong đợi và hành vi thực tế.
Thông báo lỗi : Bao gồm mọi thông báo lỗi hoặc nhật ký có liên quan.
Phụ thuộc : Liệt kê các phụ thuộc bắt buộc và phiên bản của chúng.
MRE : Cung cấp ví dụ có thể tái tạo tối thiểu.
Các bước tái tạo : Phác thảo các bước cần thiết để tái tạo vấn đề.

Để có danh sách kiểm tra đầy đủ, hãy tham khảo phần Viết mô tả rõ ràng về vấn đề .

Làm thế nào để định dạng mã của tôi đúng cách khi gửi báo cáo lỗi trên GitHub?

Để định dạng mã của bạn đúng cách khi gửi báo cáo lỗi trên GitHub:

Sử dụng ba dấu ngoặc ngược (```) để tạo khối mã.
Chỉ định ngôn ngữ lập trình để tô sáng cú pháp, ví dụ: ``` python .
Đảm bảo mã của bạn được thụt lề đúng cách để dễ đọc.

Ví dụ:

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

Để biết thêm mẹo về định dạng mã, hãy xem Định dạng mã của bạn đúng cách .

Một số lỗi thường gặp cần kiểm tra trước khi gửi báo cáo lỗi MRE là gì?

Trước khi nộp MRE, hãy đảm bảo:

Xác minh xem sự cố có thể tái diễn không.
Đảm bảo tất cả các phụ thuộc được liệt kê và chính xác.
Xóa bất kỳ mã không cần thiết nào.
Kiểm tra MRE để đảm bảo nó tái tạo được sự cố mà không cần sửa đổi.

Để biết danh sách kiểm tra chi tiết, hãy truy cập phần Kiểm tra MRE của bạn .

📅 Được tạo ra cách đây 1 năm ✏️ Đã cập nhật cách đây 2 tháng