Bỏ để qua phần nội dung

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

When submitting a bug report for Ultralytics YOLO repositories, it's essential to provide a Minimum Reproducible Example (MRE). An MRE is a small, self-contained piece of code that demonstrates the problem you're experiencing. Providing an MRE helps maintainers and contributors understand the issue and work on a fix more efficiently. This guide explains how to create an MRE when submitting bug reports to Ultralytics YOLO repositories.

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

The first step in creating an MRE is to isolate the problem. Remove any unnecessary code or dependencies that are not directly related to the issue. Focus on the specific part of the code that is causing the problem and eliminate any irrelevant sections.

2. Sử dụng các mô hình và bộ dữ liệu công cộng

When creating an MRE, use publicly available models and datasets to reproduce the issue. For example, use the yolov8n.pt model and the coco8.yaml dataset. This ensures that the maintainers and contributors can easily run your example and investigate the problem without needing access to proprietary data or custom models.

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

Ensure all necessary dependencies are included in your MRE. If your code relies on external libraries, specify the required packages and their versions. Ideally, list the dependencies in your bug report using yolo checks if you have ultralytics installed or pip list for other tools.

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

Cung cấp mô tả rõ ràng và ngắn gọn về sự cố bạn đang gặp phải. Giải thích hành vi mong đợi và hành vi thực tế bạn đang gặp phải. Nếu có, hãy bao gồm mọi thông báo lỗi hoặc nhật ký có liên quan.

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

Format your code properly using code blocks in the issue description. This makes it easier for others to read and understand your code. In GitHub, you can create a code block by wrapping your code with triple backticks (```) and specifying the language:

# Your Python code goes here

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

Trước khi gửi MRE của bạn, hãy kiểm tra nó để đả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 gặp bất kỳ sự cố hoặc sửa đổi nào.

Ví dụ về MRE

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

Mô tả lỗi:

When running inference on a 0-channel image, I get an error related to the dimensions of the input tensor.


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

In this example, the MRE demonstrates the issue with a minimal amount of code, uses a public model ("yolov8n.pt"), includes all necessary dependencies, and provides a clear description of the problem along with the error message.

By following these guidelines, you'll help the maintainers and contributors of Ultralytics YOLO repositories to understand and resolve your issue more efficiently.

Created 2023-11-12, Updated 2024-06-09
Authors: IvorZhu331 (1), glenn-jocher (3)

Ý kiến