Skip to content

[LFX Term 2 2026] Proposal for Example Restoration and CI Example Validation Framework#541

Open
ken6078 wants to merge 3 commits into
kubeedge:mainfrom
ken6078:doc/example-restoration-ci
Open

[LFX Term 2 2026] Proposal for Example Restoration and CI Example Validation Framework#541
ken6078 wants to merge 3 commits into
kubeedge:mainfrom
ken6078:doc/example-restoration-ci

Conversation

@ken6078

@ken6078 ken6078 commented Jun 13, 2026

Copy link
Copy Markdown

What type of PR is this?

/kind bug
/kind documentation
/kind design

What this PR does / why we need it:

This PR adds an Example Restoration CI pipeline that automatically scans and validates all examples, classifies detected issues, and publishes health reports for maintainers. It also includes targeted restoration work for examples/llm_simple_qa, including portable paths, documented dependencies, dataset/JSONL validation, model configuration, device fallback, and metric robustness.

Many examples may become invalid over time due to code, dependency, or documentation changes. Without automated validation, these issues are difficult to track at scale. The proposed CI provides continuous visibility into example status, helps maintain a reliable example ecosystem, and uses llm_simple_qa as the first restored reference example for validating future LLM-related examples.

Which issue(s) this PR fixes:
Fixes #230

ken6078 added 2 commits June 13, 2026 12:09
Signed-off-by: ken6078 <contact@kaiwei.dev>
Signed-off-by: ken6078 <contact@kaiwei.dev>
@kubeedge-bot kubeedge-bot added kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. kind/design Categorizes issue or PR as related to design. labels Jun 13, 2026
@kubeedge-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ken6078
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 added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 13, 2026

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

Copy link
Copy Markdown

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 introduces a comprehensive proposal for the KubeEdge Ianvs Example Classification CI Validation Framework, which aims to automate example classification, validation, and the restoration of the llm_simple_qa example. The review feedback correctly identifies minor path and spelling inconsistencies in the proposal metadata and documentation, specifically recommending the correction of examples/llm_qa_example/requestment.txt to examples/llm_simple_qa/requirements.txt.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/proposals/scenarios/example-restoration-ci/example-restoration-ci.md Outdated
Comment thread docs/proposals/scenarios/example-restoration-ci/example-restoration-ci.md Outdated
Signed-off-by: ken6078 <contact@kaiwei.dev>

@MooreZheng MooreZheng left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good to see the new proposal. As discussion,

  1. User flow can be added, e.g., the use of github action and robot
  2. Architecture design, e.g., modified and submitted modules
  3. Directory organization and design, e.g., proposals and CI
  4. Demo

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

Labels

kind/bug Categorizes issue or PR as related to a bug. kind/design Categorizes issue or PR as related to design. kind/documentation Categorizes issue or PR as related to documentation. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comprehensive Example Restoration for KubeEdge Ianvs

3 participants