为错误报告创建最小可复现示例#

向 Ultralytics YOLO 代码库提交错误报告时，提供一个最小可复现示例 (MRE) 至关重要。MRE 是一小段独立的代码，用于展示你遇到的问题。提供 MRE 有助于维护者和贡献者理解问题并更高效地着手修复。本指南将说明如何在向 Ultralytics YOLO 代码库提交错误报告时创建 MRE。

1. 隔离问题#

创建 MRE 的第一步是隔离问题。移除所有与问题没有直接关系的多余代码或依赖项。重点检查导致问题的代码部分，并删除任何无关内容。

2. 使用公开模型和数据集#

创建 MRE 时，请使用公开可用的模型和数据集来复现问题。例如，使用 yolo26n.pt 模型和 coco8.yaml 数据集。这样，维护者和贡献者就能轻松运行你的示例并调查问题，而无需访问专有数据或自定义模型。

3. 包含所有必要的依赖项#

确保 MRE 中包含所有必要的依赖项。如果你的代码依赖外部库，请注明所需软件包及其版本。理想情况下，如果你安装了 ultralytics，请在错误报告中使用 yolo checks 列出依赖项；其他工具则使用 pip list。

4. 清楚描述问题#

清晰简洁地描述你遇到的问题。说明预期行为以及实际遇到的行为。如适用，请附上相关错误消息或日志。

5. 正确格式化代码#

在问题描述中使用代码块正确地格式化代码。这样，其他人就能更轻松地阅读和理解代码。在 GitHub 中，你可以用三个反引号 (```) 包住代码来创建代码块，并指定语言：

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

6. 测试 MRE#

提交 MRE 前，请先进行测试，确保它能准确复现问题。确保其他人无需修改或遇到问题就能运行你的示例。

MRE 示例#

下面是一个假设的错误报告所用的 MRE 示例：

错误描述：

对 0 通道图像运行推理时，我遇到了一个与输入张量维度有关的错误。

MRE：

import torch

from ultralytics import YOLO

# 加载模型
model = YOLO("yolo26n.pt")

# 加载一张 0 通道图像
image = torch.rand(1, 0, 640, 640)

# 运行模型
results = model(image)

错误消息：

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

依赖项：

• torch==2.8.0
• ultralytics==8.4.142

在此示例中，MRE 以最少的代码展示了问题，使用了公开模型 ("yolo26n.pt")，包含所有必要的依赖项，并清楚地描述了问题及错误消息。

遵循这些指南，将有助于 Ultralytics YOLO 代码库的维护者和贡献者更高效地理解并解决你的问题。

常见问题#