docs: clarify dataset format configuration for testenv#377
docs: clarify dataset format configuration for testenv#377krrish175-byte wants to merge 2 commits intokubeedge:mainfrom
Conversation
Signed-off-by: krrish175-byte <krrishbiswas175@gmail.com>
Signed-off-by: krrish175-byte <krrishbiswas175@gmail.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the clarity and completeness of the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: krrish175-byte The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request does a good job of adding documentation for supported dataset formats, which will be very helpful for users. The examples for TXT, CSV, JSON, and JSONL are clear. However, there's a significant inconsistency in the configuration key names for the dataset throughout the document. The property table specifies train_url and test_url, but the YAML examples use train_index/test_index and train_data/test_data_info. This is likely to cause confusion. Please unify these keys to be consistent across the documentation. Judging by the pull request description, train_url and test_url seem to be the correct keys to use.
| {"image": "/path/to/image1.jpg", "label": "dog"}, | ||
| {"image": "/path/to/image2.jpg", "label": "cat"} |
There was a problem hiding this comment.
For consistency with the CSV example which uses image_path, it would be clearer to also use image_path here as the key for the path to the data.
| {"image": "/path/to/image1.jpg", "label": "dog"}, | |
| {"image": "/path/to/image2.jpg", "label": "cat"} | |
| {"image_path": "/path/to/image1.jpg", "label": "dog"}, | |
| {"image_path": "/path/to/image2.jpg", "label": "cat"} |
| {"image": "/path/to/image1.jpg", "label": "dog"} | ||
| {"image": "/path/to/image2.jpg", "label": "cat"} |
There was a problem hiding this comment.
For consistency with the CSV example, please use image_path here as well instead of image.
| {"image": "/path/to/image1.jpg", "label": "dog"} | |
| {"image": "/path/to/image2.jpg", "label": "cat"} | |
| {"image_path": "/path/to/image1.jpg", "label": "dog"} | |
| {"image_path": "/path/to/image2.jpg", "label": "cat"} |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR adds detailed documentation regarding the supported dataset formats in docs/user_interface/how-to-config-testenv.md. It explains the data formats needed for
train_urlandtest_urlinsidetestenv.yamland provides concrete examples for TXT, CSV, JSON, and JSONL formats so that users can easily prepare their datasets. It also cleans up redundant comments from the configuration examples for better readability.Which issue(s) this PR fixes:
Fixes #110