Repository navigation
Redesign the README - #1035
Redesign the README#1035
Conversation
| result = model(SAMPLE_IMAGE, save=True) | ||
| ``` | ||
|
|
||
| Load any model straight from Hugging Face by its repo name: `LibreYOLO("LibreYOLO/LibreRFDETRn")`. |
There was a problem hiding this comment.
The example needs extra packages
After the documented pip install libreyolo, this example fails because repo-name loading needs huggingface_hub. The English RF-DETR example also needs transformers. Add pip install "libreyolo[hf,rfdetr]" beside this example and the hf prerequisite beside the Chinese example so readers can run them without missing-package errors.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| and r["dataset"]["id"] == "coco2017" | ||
| and r["model"]["id"] in wanted |
There was a problem hiding this comment.
Chart refresh ignores image count
refresh() accepts results without checking the advertised 500-image subset. If a replacement result for the same model and device uses a different image count, the README will still label it as 500 images. Reject rows whose dataset.num_images is not 500 before writing the CSV.
| and r["dataset"]["id"] == "coco2017" | |
| and r["model"]["id"] in wanted | |
| and r["dataset"]["id"] == "coco2017" | |
| and r["dataset"]["num_images"] == 500 | |
| and r["model"]["id"] in wanted |
What: README redesign for the English landing page.
Why: shorter page with a banner, task-first sections and links to the guides.
docs/readme/banner.png, sourcescripts/readme/banner.html) and a one-line descriptionSPONSORS.mdtouched by the earlier commit on this branchpaddleadded to the extras left out ofall, matchingpyproject.tomlCheck: rendered README on the branch, light and dark theme.
Not verified: unit tests were not run locally (no pytest in the environment);
README.zh-CN.mdhas the banner and the earlier section order but does not yet mirror the latest English changes (it still has the chart and the removed sections); theLibreYOLO("LibreYOLO/LibreRFDETRn")example was not executed; the Greptile CLI pre-review had not finished when this PR was opened.Opened by an agent.
Code provenance
Original content written for this PR: README text, a banner image rendered from first-party HTML/CSS using the project's own logo mark, and a standard-library chart script from the earlier commit on this branch. The banner text is set in Outfit and JetBrains Mono (both SIL Open Font License) and shipped only as a rendered PNG. No third-party code ported, adapted, or introduced; no GPL/AGPL/LGPL/non-commercial/unknown-license material involved.
The PR appears safe to merge, with non-blocking fixes for example prerequisites and chart refresh checks.
Summary
Redesigns the English landing page with a banner, task-first examples, model links, and supporter avatars. Also updates the Chinese README and adds a chart generator.
Reviews (1) · Last reviewed commit: "Add README banner and simplify sections" · Reviewed by Greptile