Ultralytics YOLO 리포지토리에서 버그 리포트를 위한 최소 재현 가능한 예제 만들기

Ultralytics YOLO 리포지토리에 버그 리포트를 제출할 때는 재현 가능한 최소한의 예제 (MRE)를 제공해야 합니다. MRE는 발생한 문제를 보여주는 작고 독립적인 코드 조각입니다. MRE를 제공하면 관리자와 기여자가 문제를 이해하고 보다 효율적으로 수정 작업을 하는 데 도움이 됩니다. 이 가이드에서는 Ultralytics YOLO 리포지토리에 버그 리포트를 제출할 때 MRE를 만드는 방법을 설명합니다.

1. 문제 격리하기

MRE를 만드는 첫 번째 단계는 문제를 격리하는 것입니다. 즉, 문제와 직접 관련이 없는 불필요한 코드나 종속성을 모두 제거해야 합니다. 문제를 일으키는 코드의 특정 부분에 집중하고 관련 없는 코드를 모두 제거하세요.

2. 공개 모델 및 데이터 세트 사용

MRE를 만들 때는 공개적으로 사용 가능한 모델과 데이터 세트를 사용하여 문제를 재현하세요. 예를 들어 'yolov8n.pt' 모델과 'coco8.yaml' 데이터 집합을 사용하세요. 이렇게 하면 유지 관리자와 기여자가 독점 데이터나 사용자 지정 모델에 액세스하지 않고도 예제를 쉽게 실행하고 문제를 조사할 수 있습니다.

3. 필요한 모든 종속성 포함하기

MRE에 필요한 모든 종속성을 포함해야 합니다. 코드가 외부 라이브러리에 의존하는 경우 필요한 패키지와 해당 버전을 지정하세요. 이상적으로는 requirements.txt 파일을 만들거나 버그 리포트에 종속성을 나열하세요.

4. 문제에 대한 명확한 설명 작성

발생한 문제에 대해 명확하고 간결하게 설명하세요. 예상되는 동작과 실제로 발생한 동작을 설명하세요. 해당되는 경우 관련 오류 메시지나 로그를 포함하세요.

5. 올바른 코드 형식 지정

MRE를 제출할 때는 이슈 설명에 코드 블록을 사용하여 코드 형식을 올바르게 지정하세요. 이렇게 하면 다른 사람들이 코드를 더 쉽게 읽고 이해할 수 있습니다. GitHub에서는 코드를 세 개의 백틱(```)으로 묶고 언어를 지정하여 코드 블록을 만들 수 있습니다:

# Your Python code goes here

6. MRE 테스트

MRE를 제출하기 전에 테스트하여 문제를 정확하게 재현하는지 확인하세요. 다른 사람들이 문제나 수정 없이 예제를 실행할 수 있는지 확인하세요.

MRE의 예

다음은 가상의 버그 보고서에 대한 MRE의 예입니다:

버그 설명:

실행할 때 detect.py 스크립트를 'coco8.yaml' 데이터 집합의 샘플 이미지에 실행하면 입력 크기와 관련된 오류가 발생합니다 tensor.

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)

오류 메시지입니다:

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

종속성:

• torch==2.0.0
• ultralytics==8.0.90

이 예제에서는 최소한의 코드로 문제를 시연하고, 공개 모델('yolov8n.pt')을 사용하며, 필요한 모든 종속성을 포함하고, 오류 메시지와 함께 문제에 대한 명확한 설명을 제공합니다.

이 가이드라인을 따르면 Ultralytics YOLO 리포지토리의 관리자와 기여자가 문제를 더 효율적으로 이해하고 해결하는 데 도움이 됩니다.

댓글