Skip to content

docs: clarify dataset format configuration for testenv#377

Open
krrish175-byte wants to merge 2 commits intokubeedge:mainfrom
krrish175-byte:fix/issue-110
Open

docs: clarify dataset format configuration for testenv#377
krrish175-byte wants to merge 2 commits intokubeedge:mainfrom
krrish175-byte:fix/issue-110

Conversation

@krrish175-byte
Copy link
Copy Markdown

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_url and test_url inside testenv.yaml and 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

Signed-off-by: krrish175-byte <krrishbiswas175@gmail.com>
Signed-off-by: krrish175-byte <krrishbiswas175@gmail.com>
@kubeedge-bot kubeedge-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 23, 2026
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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 testenv configuration documentation. By providing explicit details and practical examples for various dataset formats, it streamlines the user experience for data preparation, reducing potential confusion and errors when setting up test environments.

Highlights

  • Enhanced Dataset Format Documentation: Detailed explanations and examples have been added for supported dataset formats including TXT, CSV, JSON, and JSONL, clarifying how users should prepare their data for train_url and test_url in testenv.yaml.
  • Improved Readability of Configuration Examples: Redundant and verbose comments have been removed from the testenv.yaml configuration examples, making them cleaner and easier to understand.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@kubeedge-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: krrish175-byte
To complete the pull request process, please assign moorezheng after the PR has been reviewed.
You can assign the PR to them by writing /assign @moorezheng in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubeedge-bot kubeedge-bot requested review from Poorunga and hsj576 March 23, 2026 19:17
@kubeedge-bot kubeedge-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 23, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +54 to +55
{"image": "/path/to/image1.jpg", "label": "dog"},
{"image": "/path/to/image2.jpg", "label": "cat"}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
{"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"}

Comment on lines +61 to +62
{"image": "/path/to/image1.jpg", "label": "dog"}
{"image": "/path/to/image2.jpg", "label": "cat"}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the CSV example, please use image_path here as well instead of image.

Suggested change
{"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"}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add more information about dataset

2 participants