Docs: Issue Examples Gallery – correct asset URLs, contributing guide, and gallery structure#273
Open
PredictiveManish wants to merge 1 commit intocleanlab:mainfrom
Open
Docs: Issue Examples Gallery – correct asset URLs, contributing guide, and gallery structure#273PredictiveManish wants to merge 1 commit intocleanlab:mainfrom
PredictiveManish wants to merge 1 commit intocleanlab:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Purpose: Add a static docs page that acts as a continuously growing gallery of example images for each issue type detected by CleanVision. Images are stored in the cleanlab/assets repo (not in CleanVision). This PR (1) fixes the Issue Examples Gallery to use the image URLs that actually exist in that repo, (2) adds clear instructions for contributors on how to add more examples, and (3) documents where to source images (e.g. running CleanVision on datasets, Kaggle, blog posts). No new code or APIs; documentation and CONTRIBUTING updates only.
(No runnable code—docs-only change. The gallery is viewed at the built docs URL, e.g.
Issue Examples Galleryunder Tutorials.)Impact
Areas affected:
docs/source/issue_examples.rst— Rewritten to use correct asset filenames (blurry.png,dark.jpg,light.jpg, etc.) fromcleanlab/assets, intro/contributing note, and an “Adding more examples” section.CONTRIBUTING.md— New “Documentation and example images” subsection under Pull Requests pointing to the assets repo and the gallery’s “Adding more examples” section.Who’s affected: Docs readers and contributors who want to view or add compelling example images per issue type (Blurry, Dark, Light, Grayscale, Low Information, Odd Aspect Ratio, Odd Size, Exact Duplicates, Near Duplicates).
Screenshots
Testing
Testing done: Built the Sphinx docs locally (
cd docs && make htmlor equivalent) and confirmed (1) the Issue Examples Gallery builds without RST errors, (2) images load fromhttps://raw.githubusercontent.com/cleanlab/assets/master/cleanvision/example_issue_images/, and (3) CONTRIBUTING.md renders correctly.Unaddressed Cases
Links to Relevant Issues or Conversations
References
https://raw.githubusercontent.com/cleanlab/assets/master/cleanvision/example_issue_images/<filename>Reviewer Notes
blurry_2.jpg,dark_food101.jpg), new.. figure::blocks can be added in the same pattern inissue_examples.rst; no further template changes are required.