Skip to content

docs: update qiskit_code_validation example defaults#743

Merged
ajbozarth merged 3 commits into
generative-computing:mainfrom
ajbozarth:qiskit-code-validation-ivr-example
Mar 27, 2026
Merged

docs: update qiskit_code_validation example defaults#743
ajbozarth merged 3 commits into
generative-computing:mainfrom
ajbozarth:qiskit-code-validation-ivr-example

Conversation

@ajbozarth

@ajbozarth ajbozarth commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue: Fixes

Follows up on #717 to add system prompt and grounding context support to the qiskit_code_validation IVR example.

Adds QISKIT_SYSTEM_PROMPT as an optional tuning aid (disabled by default) for use with non-specialized models, and wires system_prompt and grounding_context as optional parameters through generate_validated_qiskit_code(). The default config (Qiskit-specialized model, RepairTemplateStrategy, no system prompt) is unchanged and now explicitly documented. README updated to reflect configuration options and model guidance.

Benchmarking data supporting these decisions (prompt corpus, run results, and analysis docs) is available in @ajbozarth's toolbox repo.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

@ajbozarth ajbozarth self-assigned this Mar 25, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify

mergify Bot commented Mar 25, 2026

Copy link
Copy Markdown

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@ajbozarth

Copy link
Copy Markdown
Contributor Author

This is draft as I'm still wrapping up my final benchmarks and intend to update the benchmark results section of the README once they're done. I'll also update toolbox repo with the remaining results once it's finished. It pushes my laptop to it's limit so I'm running them overnight and it will take two more nights to finish (should have results on Friday)

Switch default model to hf.co/Qiskit/mistral-small-3.2-24b-qiskit-GGUF
and inline QISKIT_SYSTEM_PROMPT as a documented optional tuning aid for
non-specialized models. Update README to match.

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
@ajbozarth ajbozarth force-pushed the qiskit-code-validation-ivr-example branch from d3d637e to 1e62d53 Compare March 25, 2026 21:10
Replace outdated benchmark table with completed run data and add
check() correctness finding (~32.5% on QHE).

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
@ajbozarth ajbozarth marked this pull request as ready for review March 26, 2026 17:29
@ajbozarth ajbozarth requested a review from a team as a code owner March 26, 2026 17:29
@ajbozarth

Copy link
Copy Markdown
Contributor Author

Updated with the benchmark results and moved out of draft.

@ajbozarth

Copy link
Copy Markdown
Contributor Author

cc @vabarbosa

@ajbozarth ajbozarth requested a review from psschwei March 26, 2026 17:30

@vabarbosa vabarbosa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

hello @ajbozarth. this is good, but i do have just a couple comments below. thank you!

…EADME

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>

@vabarbosa vabarbosa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thank you!

@ajbozarth ajbozarth enabled auto-merge March 27, 2026 18:25

@psschwei psschwei left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

tests pass and Va approved, fine with me

@ajbozarth ajbozarth added this pull request to the merge queue Mar 27, 2026
Merged via the queue into generative-computing:main with commit fd51c2b Mar 27, 2026
7 checks passed
@ajbozarth ajbozarth deleted the qiskit-code-validation-ivr-example branch March 27, 2026 20:10
akihikokuroda pushed a commit to akihikokuroda/mellea that referenced this pull request May 27, 2026
…uting#743)

* docs: update qiskit_code_validation example defaults

Switch default model to hf.co/Qiskit/mistral-small-3.2-24b-qiskit-GGUF
and inline QISKIT_SYSTEM_PROMPT as a documented optional tuning aid for
non-specialized models. Update README to match.

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>

* docs: update qiskit_code_validation README benchmark results

Replace outdated benchmark table with completed run data and add
check() correctness finding (~32.5% on QHE).

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>

* docs: add grounding_context usage example to qiskit_code_validation README

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>

---------

Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants