ultralytics / ultralytics/docs

Normative description of "YOLO format"

Open
#279 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
127
Forks
14
Avg merge
30m
Merged PRs (30d)
5

Description

Search before asking
Description

See this forum question. Multiple docs describe the "YOLO format" and its data.yaml (or dota8.yaml, etc.), including:

Some docs also contradict each other. Moreover, these are mostly example-driven; the exact requirements aren't stated clearly, at least not where I was able to find readily. For example, which keys are required? What can the YAML file be named? Is path: sub/path supported? Is it images/train or train/images?

A simple, normative description would be helpful -- natural-language text, a JSON Schema, both, or anything else.

See also https://github.com/ultralytics/ultralytics/issues/23747

Use case

This would have been very helpful when I was trying to diagnose a problem I was having with uploads (in the linked forum post). I'm thinking a lot of existing documentation could also be removed (replaced with a link to the dedicated doc) for easier reading and maintenance.

Additional

No response

Are you willing to submit a PR?
  • Yes I'd like to help by submitting a PR!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the YOLO dataset documentation at the four linked docs pages, along with the linked forum question and related issue. Identify the conflicting requirements and determine the scope of a single normative reference, including how existing examples should point to it. Done means the supported YAML and dataset structure requirements are stated consistently across the affected documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.