버그 리포트를 위한 최소 재현 가능 예제 만들기
Ultralytics YOLO 저장소에 버그 리포트를 제출할 때는 최소 재현 가능 예제(MRE)를 제공하는 것이 필수적입니다. MRE는 사용자가 겪고 있는 문제를 설명하는 작고 독립적인 코드 조각입니다. MRE를 제공하면 관리자와 기여자가 문제를 이해하고 더 효율적으로 수정 작업을 수행하는 데 도움이 됩니다. 이 가이드는 Ultralytics YOLO 저장소에 버그 리포트를 제출할 때 MRE를 만드는 방법을 설명합니다.
문제 분리하기
MRE를 만드는 첫 번째 단계는 문제를 분리하는 것입니다. 문제와 직접적인 관련이 없는 불필요한 코드나 종속성을 제거하십시오. 문제를 일으키는 코드의 특정 부분에 집중하고 관련 없는 섹션은 모두 제거하십시오.
공개 모델 및 데이터셋 사용하기
MRE를 만들 때는 공개적으로 사용 가능한 모델과 데이터셋을 사용하여 문제를 재현하십시오. 예를 들어 yolo26n.pt 모델과 coco8.yaml 데이터셋을 사용하십시오. 이렇게 하면 관리자와 기여자가 독점 데이터나 커스텀 모델에 액세스할 필요 없이 예제를 쉽게 실행하고 문제를 조사할 수 있습니다.
필요한 모든 종속성 포함하기
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.
문제에 대한 명확한 설명 작성하기
현재 겪고 있는 문제에 대해 명확하고 간결한 설명을 제공하십시오. 예상되는 동작과 실제로 발생하는 동작을 설명하십시오. 해당되는 경우 관련 오류 메시지나 로그를 포함하십시오.
코드 서식 올바르게 지정하기
이슈 설명에서 코드 블록을 사용하여 코드 서식을 올바르게 지정하십시오. 이렇게 하면 다른 사람들이 귀하의 코드를 더 쉽게 읽고 이해할 수 있습니다. GitHub에서는 코드를 세 개의 백틱(```)으로 감싸고 언어를 지정하여 코드 블록을 만들 수 있습니다.
```python
# Your Python code goes here
```MRE 테스트하기
MRE를 제출하기 전에 테스트하여 문제가 정확하게 재현되는지 확인하십시오. 다른 사람들이 문제나 수정 사항 없이 예제를 실행할 수 있는지 확인하십시오.
MRE 예시
다음은 가상의 버그 리포트를 위한 MRE 예시입니다.
버그 설명:
0채널 이미지에서 추론을 실행할 때 입력 텐서의 차원과 관련된 오류가 발생합니다.
MRE:
import torch
from ultralytics import YOLO
# Load the model
model = YOLO("yolo26n.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.3.0ultralytics==8.2.0
이 예시에서 MRE는 최소한의 코드로 문제를 보여주며, 공개 모델("yolo26n.pt")을 사용하고, 필요한 모든 종속성을 포함하며, 오류 메시지와 함께 문제에 대한 명확한 설명을 제공합니다.
이 지침을 따르면 Ultralytics YOLO 저장소의 관리자와 기여자가 귀하의 문제를 더 효율적으로 이해하고 해결하는 데 도움이 됩니다.
FAQ
Ultralytics YOLO 저장소의 버그 리포트를 위해 효과적인 최소 재현 가능 예제(MRE)를 어떻게 만들 수 있습니까?
Ultralytics YOLO 저장소의 버그 리포트를 위해 효과적인 최소 재현 가능 예제(MRE)를 만들려면 다음 단계를 따르십시오:
- 문제 분리: 문제와 직접적인 관련이 없는 코드나 종속성을 제거하십시오.
- 공개 모델 및 데이터셋 사용: 재현 용이성을 위해
yolo26n.pt및coco8.yaml과 같은 공개 리소스를 활용하십시오. - Include All Necessary Dependencies: Specify required packages and their versions. You can list dependencies using
yolo checksif you haveultralyticsinstalled orpip list. - 문제에 대한 명확한 설명 작성: 오류 메시지나 로그를 포함하여 예상되는 동작과 실제 동작을 설명하십시오.
- 코드 서식 올바르게 지정: 코드 블록을 사용하여 코드 서식을 지정하면 가독성이 향상됩니다.
- MRE 테스트: 수정 없이 MRE가 문제를 재현하는지 확인하십시오.
자세한 가이드는 최소 재현 가능 예제 만들기를 참조하십시오.
Ultralytics YOLO 버그 리포트를 위한 MRE에서 왜 공개적으로 사용 가능한 모델과 데이터셋을 사용해야 합니까?
MRE에서 공개적으로 사용 가능한 모델과 데이터셋을 사용하면 관리자가 독점 데이터에 액세스할 필요 없이 귀하의 예제를 쉽게 실행할 수 있습니다. 이는 더 빠르고 효율적인 문제 해결을 가능하게 합니다. 예를 들어, yolo26n.pt 모델과 coco8.yaml 데이터셋을 사용하면 디버깅 프로세스를 표준화하고 간소화하는 데 도움이 됩니다. 공개 모델 및 데이터셋에 대한 자세한 내용은 공개 모델 및 데이터셋 사용 섹션을 참조하십시오.
Ultralytics YOLO 버그 리포트에 어떤 정보를 포함해야 합니까?
포괄적인 Ultralytics YOLO 버그 리포트에는 다음 내용이 포함되어야 합니다:
- 명확한 설명: 문제, 예상 동작, 실제 동작을 설명하십시오.
- 오류 메시지: 관련 오류 메시지나 로그를 포함하십시오.
- 종속성: 필요한 종속성과 해당 버전을 나열하십시오.
- MRE: 최소 재현 가능 예제를 제공하십시오.
- 재현 단계: 문제를 재현하는 데 필요한 단계를 개략적으로 설명하십시오.
전체 체크리스트는 문제에 대한 명확한 설명 작성 섹션을 참조하십시오.
GitHub에 버그 리포트를 제출할 때 어떻게 코드를 올바르게 서식 지정할 수 있습니까?
GitHub에 버그 리포트를 제출할 때 코드를 올바르게 서식 지정하려면 다음을 수행하십시오:
- 세 개의 백틱(```)을 사용하여 코드 블록을 만드십시오.
- 구문 강조를 위해 프로그래밍 언어를 지정하십시오(예: ```python).
- 가독성을 위해 코드가 올바르게 들여쓰기되었는지 확인하십시오.
예시:
```python
# Your Python code goes here
```코드 서식에 대한 자세한 팁은 코드 서식 올바르게 지정을 참조하십시오.
버그 리포트를 위해 MRE를 제출하기 전에 확인해야 할 일반적인 오류는 무엇입니까?
MRE를 제출하기 전에 다음 사항을 확인하십시오:
- 문제가 재현 가능한지 확인하십시오.
- 모든 종속성이 나열되었고 올바른지 확인하십시오.
- 불필요한 코드를 모두 제거하십시오.
- MRE를 테스트하여 수정 없이 문제가 재현되는지 확인하십시오.
자세한 체크리스트는 MRE 테스트 섹션을 방문하십시오.