@oqtopus-team/pi-qcaleval 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright yyyy OQTOPUS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,142 @@
-# Temporary Holding Version
+# pi-qcaleval
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A [pi](https://github.com/badlogic/pi-mono) extension that sends superconducting
+qubit calibration plots to a dedicated calibration-evaluation VLM and returns a
+structured diagnosis. The default model is
+[NVIDIA Ising-Calibration](https://build.nvidia.com/nvidia/ising-calibration-1.5-31b/modelcard)
+served by vLLM, and the questions are the ones it was trained and benchmarked
+on: the six questions of
+[QCalEval](https://arxiv.org/abs/2604.25884), asked the way the benchmark asks
+them.
+
+The planner model keeps the conversation; `qcal_evaluate` is the tool it calls
+whenever a calibration figure needs a fit-quality judgement, parameter
+extraction, or a status verdict. The extension has no QDash dependency, so it
+works from the pi CLI and from the QDash Copilot runtime alike.
+
+## Tool
+
+`qcal_evaluate(context, question?, task_name?, knowledge?, criteria?, images?, max_images?, use_examples?, examples?, questions?)`
+asks the evaluation model six questions, each in its own single-turn request
+(no system prompt), with the figure at the position the benchmark's templates
+put it, and returns the parsed answers as `details.diagnosis`:
+
+| key | the benchmark's question | parsed answer |
+| --- | --- | --- |
+| `technical_description` | Q1 Describe the figure in JSON | `{plot_type, x_axis, y_axis, main_features}`, or the text when not JSON |
+| `experimental_conclusion` | Q2 Classify the outcome | `{classification: expected \| suboptimal \| anomalous \| apparatus, reason}` |
+| `experimental_significance` | Q3 What does this result imply | text |
+| `fit_reliability` | Q4 Is the fit reliable for extraction | `{assessment: reliable \| unreliable \| no_fit, reason}` |
+| `parameter_extraction` | Q5 Extract parameters in JSON | the object, or the text when not JSON |
+| `calibration_diagnosis` | Q6 Determine the status | `{status: CODE, suggested_range, notes}` |
+
+plus `success`: whether the status is `SUCCESS` (or, when the status question
+was not asked, whether the outcome is `expected`). `details.answers` keeps every
+answer as returned, `details.questions` the questions asked, `details.prompt`
+every user turn the model received (with `[figure]` where an image was), and
+`details.calls` each question's call with its duration, stop reason, and input
+and output tokens. A call that fails is retried once, as the benchmark retries API
+failures; nothing is re-asked for its content. Questions that got no answer are
+listed in `details.missing_keys`. `questions` asks a subset. `dry_run` builds
+the prompts and returns them (`details.prompts` by question, `details.prompt`
+as one text) without asking the model, so a host can show what a task's
+reference and examples turn into; the figure may be omitted then.
+
+`knowledge` is the experiment background the benchmark prepends to Q2–Q6: a few
+sentences on what the experiment sweeps and what a successful result looks like.
+`criteria` fills the family-specific parts of the templates: `guidance` (the
+points Q3 should explain), `parameters` (the Q5 schema, name to type),
+`statuses` (the Q6 decision criteria, code to criterion, `SUCCESS` first) and
+`range_format`. A host that keeps such knowledge per task fills both in from
+`task_name`, so the planner only names the task. Without them the templates use
+generic guidance, ask for whatever parameters the plot determines, and offer
+`SUCCESS` / `SUBOPTIMAL` / `NO_SIGNAL` / `ANOMALOUS`.
+
+`context` is what the background cannot know (the task, the target, a swept
+range); the model reads values off the plot, so do not pass fitted results. A
+`question` is added to Q3 as one more point to address.
+
+`images` are base64 image blocks. A host may fill them in from the most recent
+figures of the conversation, so the planner does not have to pass image bytes;
+`max_images` (default 1, up to 4) says how many of the newest figures to supply,
+for example 2 when an expected reference figure precedes the measured result.
+The last figure is the one judged; earlier ones are shown as references.
+
+### Labeled examples (in-context)
+
+With `use_examples`, the host supplies `examples`: each is one or more figures
+with the answers an expert validated (`scenario`, `analysis`, `parameters`,
+`status`, `suggested_range`). They are laid out as the benchmark's few-shot
+split lays them out, examples first and the query figure last, and only for the
+three questions the benchmark uses them for: Q3 shows each example's
+`analysis` under `Scenario "<scenario>":`, Q5 shows one example's
+`parameters`, Q6 shows each example's `Status:` and `Suggested range:`. Up to
+six examples and six example figures are shown; the rest are dropped in order.
+
+## Configuration
+
+No setting is required. The evaluation model is resolved in this order:
+
+1. the call's `model` (`provider/modelId`), when the host offers several evaluation models, then
+   `QCALEVAL_MODEL`, an explicit override for pi CLI use;
+2. a configured calibration VLM, recognised by its id (`Ising-Calibration`);
+3. the conversation's own model, when it accepts images. The result is then
+   marked `fallback: true` in `details`, so a host without an Ising deployment
+   still gets a diagnosis from the vision model it already runs.
+
+The output budget per answer follows the model's `maxTokens` (at most 4096). The
+benchmark decodes greedily; set the model's temperature to 0 for reproducible
+answers.
+
+The provider must be declared in pi's `models.json` with its base URL and
+credential, for example:
+
+```json
+{
+  "providers": {
+    "vllm": {
+      "baseUrl": "https://llm.example/v1",
+      "api": "openai-completions",
+      "apiKey": "$VLLM_API_KEY",
+      "models": [{ "id": "nvidia/Ising-Calibration-1.5-31B-NVFP4", "contextWindow": 16384, "maxTokens": 2048, "input": ["text", "image"] }]
+    }
+  }
+}
+```
+
+Each request carries one plot, the background and one question, so an
+evaluation fits comfortably in a 16k-token deployment; the six requests run at
+once.
+
+## Installation
+
+```bash
+pi install npm:@oqtopus-team/pi-qcaleval
+```
+
+The package is now published as `@oqtopus-team/pi-qcaleval`. Existing pi CLI users
+should remove `@orangekame3/pi-qcaleval` before installing the new package to avoid
+loading both extensions. Historical releases remain available under the old name.
+
+Releases use QDash tags `pi-qcaleval/vX.Y.Z` and publish to npm as `latest`.
+Changes to the pi packages on QDash's `develop` branch publish `beta` prereleases
+(`npm:@oqtopus-team/pi-qcaleval@beta`).
+
+## Development
+
+From the QDash repository root:
+
+```bash
+bun install --frozen-lockfile
+task ci-pi-packages
+task ci-agent-runtime
+pi -e ./packages/pi-qcaleval
+```
+
+The QDash runtime includes this package from the same checkout. Rebuild it after
+editing with `docker compose up -d --build agent-runtime`. See the
+[package release guide](../../docs/developer-guide/copilot/packages.md).
+
+## License
+
+Apache-2.0