Add FAQs to Docs Datasets and Help sections (#14211)
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com> Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
This commit is contained in:
parent
64862f1b69
commit
d5db9c916f
73 changed files with 3296 additions and 110 deletions
|
|
@ -77,3 +77,63 @@ RuntimeError: Expected input[1, 0, 640, 640] to have 3 channels, but got 0 chann
|
|||
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](https://github.com/ultralytics/ultralytics/graphs/contributors) of Ultralytics YOLO repositories to understand and resolve your issue more efficiently.
|
||||
|
||||
## FAQ
|
||||
|
||||
### How do I create an effective Minimum Reproducible Example (MRE) for bug reports in Ultralytics YOLO repositories?
|
||||
|
||||
To create an effective Minimum Reproducible Example (MRE) for bug reports in Ultralytics YOLO repositories, follow these steps:
|
||||
|
||||
1. **Isolate the Problem**: Remove any code or dependencies that are not directly related to the issue.
|
||||
2. **Use Public Models and Datasets**: Utilize public resources like `yolov8n.pt` and `coco8.yaml` for easier reproducibility.
|
||||
3. **Include All Necessary Dependencies**: Specify required packages and their versions. You can list dependencies using `yolo checks` if you have `ultralytics` installed or `pip list`.
|
||||
4. **Write a Clear Description of the Issue**: Explain the expected and actual behavior, including any error messages or logs.
|
||||
5. **Format Your Code Properly**: Use code blocks to format your code, making it easier to read.
|
||||
6. **Test Your MRE**: Ensure your MRE reproduces the issue without modifications.
|
||||
|
||||
For a detailed guide, see [Creating a Minimum Reproducible Example](#creating-a-minimum-reproducible-example-for-bug-reports-in-ultralytics-yolo-repositories).
|
||||
|
||||
### Why should I use publicly available models and datasets in my MRE for Ultralytics YOLO bug reports?
|
||||
|
||||
Using publicly available models and datasets in your MRE ensures that maintainers can easily run your example without needing access to proprietary data. This allows for quicker and more efficient issue resolution. For instance, using the `yolov8n.pt` model and `coco8.yaml` dataset helps standardize and simplify the debugging process. Learn more about public models and datasets in the [Use Public Models and Datasets](#2-use-public-models-and-datasets) section.
|
||||
|
||||
### What information should I include in my bug report for Ultralytics YOLO?
|
||||
|
||||
A comprehensive bug report for Ultralytics YOLO should include:
|
||||
|
||||
- **Clear Description**: Explain the issue, expected behavior, and actual behavior.
|
||||
- **Error Messages**: Include any relevant error messages or logs.
|
||||
- **Dependencies**: List required dependencies and their versions.
|
||||
- **MRE**: Provide a Minimum Reproducible Example.
|
||||
- **Steps to Reproduce**: Outline the steps needed to reproduce the issue.
|
||||
|
||||
For a complete checklist, refer to the [Write a Clear Description of the Issue](#4-write-a-clear-description-of-the-issue) section.
|
||||
|
||||
### How can I format my code properly when submitting a bug report on GitHub?
|
||||
|
||||
To format your code properly when submitting a bug report on GitHub:
|
||||
|
||||
- Use triple backticks (\```) to create code blocks.
|
||||
- Specify the programming language for syntax highlighting, e.g., \```python.
|
||||
- Ensure your code is indented correctly for readability.
|
||||
|
||||
Example:
|
||||
|
||||
````bash
|
||||
```python
|
||||
# Your Python code goes here
|
||||
```
|
||||
````
|
||||
|
||||
For more tips on code formatting, see [Format Your Code Properly](#5-format-your-code-properly).
|
||||
|
||||
### What are some common errors to check before submitting my MRE for a bug report?
|
||||
|
||||
Before submitting your MRE, make sure to:
|
||||
|
||||
- Verify the issue is reproducible.
|
||||
- Ensure all dependencies are listed and correct.
|
||||
- Remove any unnecessary code.
|
||||
- Test the MRE to ensure it reproduces the issue without modifications.
|
||||
|
||||
For a detailed checklist, visit the [Test Your MRE](#6-test-your-mre) section.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue