pluginbench 0.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pluginbench-0.5.0/.gitignore +17 -0
- pluginbench-0.5.0/LICENSE +201 -0
- pluginbench-0.5.0/PKG-INFO +294 -0
- pluginbench-0.5.0/README.md +258 -0
- pluginbench-0.5.0/pyproject.toml +72 -0
- pluginbench-0.5.0/src/pluginbench/__init__.py +3 -0
- pluginbench-0.5.0/src/pluginbench/__main__.py +3 -0
- pluginbench-0.5.0/src/pluginbench/assessment-charts.html +790 -0
- pluginbench-0.5.0/src/pluginbench/assessment.py +316 -0
- pluginbench-0.5.0/src/pluginbench/assessment_charts.py +1225 -0
- pluginbench-0.5.0/src/pluginbench/assessment_metrics.py +1956 -0
- pluginbench-0.5.0/src/pluginbench/assessment_models.py +127 -0
- pluginbench-0.5.0/src/pluginbench/baselines.py +792 -0
- pluginbench-0.5.0/src/pluginbench/claude.py +374 -0
- pluginbench-0.5.0/src/pluginbench/cli.py +672 -0
- pluginbench-0.5.0/src/pluginbench/code_diff.py +207 -0
- pluginbench-0.5.0/src/pluginbench/codex.py +451 -0
- pluginbench-0.5.0/src/pluginbench/codex_events.py +585 -0
- pluginbench-0.5.0/src/pluginbench/collectors.py +591 -0
- pluginbench-0.5.0/src/pluginbench/compare.py +927 -0
- pluginbench-0.5.0/src/pluginbench/components.py +129 -0
- pluginbench-0.5.0/src/pluginbench/coverage_report.py +610 -0
- pluginbench-0.5.0/src/pluginbench/datasets.py +207 -0
- pluginbench-0.5.0/src/pluginbench/evaluation.example.yaml +45 -0
- pluginbench-0.5.0/src/pluginbench/evaluation.py +1651 -0
- pluginbench-0.5.0/src/pluginbench/evaluation_report.py +1004 -0
- pluginbench-0.5.0/src/pluginbench/fallow_parse.mjs +101 -0
- pluginbench-0.5.0/src/pluginbench/harbor_backend.py +2946 -0
- pluginbench-0.5.0/src/pluginbench/isolation.py +314 -0
- pluginbench-0.5.0/src/pluginbench/judge.py +683 -0
- pluginbench-0.5.0/src/pluginbench/language_analysis.py +915 -0
- pluginbench-0.5.0/src/pluginbench/ledger.py +217 -0
- pluginbench-0.5.0/src/pluginbench/measurement_profiles.py +616 -0
- pluginbench-0.5.0/src/pluginbench/native_treatment_runtime.js +221 -0
- pluginbench-0.5.0/src/pluginbench/native_treatments.py +155 -0
- pluginbench-0.5.0/src/pluginbench/observer_data/go-analysis-v1/go.mod +10 -0
- pluginbench-0.5.0/src/pluginbench/observer_data/go-analysis-v1/go.sum +10 -0
- pluginbench-0.5.0/src/pluginbench/observer_data/go-analysis-v1/main.go +64 -0
- pluginbench-0.5.0/src/pluginbench/observer_data/oxc-parser-0.126.0/package-lock.json +449 -0
- pluginbench-0.5.0/src/pluginbench/observer_data/oxc-parser-0.126.0/package.json +5 -0
- pluginbench-0.5.0/src/pluginbench/parallel.py +101 -0
- pluginbench-0.5.0/src/pluginbench/processes.py +100 -0
- pluginbench-0.5.0/src/pluginbench/remeasure.py +992 -0
- pluginbench-0.5.0/src/pluginbench/run_lock.py +227 -0
- pluginbench-0.5.0/src/pluginbench/run_status.py +518 -0
- pluginbench-0.5.0/src/pluginbench/study.py +1858 -0
- pluginbench-0.5.0/src/pluginbench/study_review.py +924 -0
- pluginbench-0.5.0/src/pluginbench/submissions.py +486 -0
- pluginbench-0.5.0/src/pluginbench/task_sources.py +403 -0
- pluginbench-0.5.0/src/pluginbench/treatments.py +388 -0
- pluginbench-0.5.0/src/pluginbench/trial_containers.py +94 -0
- pluginbench-0.5.0/src/pluginbench/vendor/ECHARTS-LICENSE +222 -0
- pluginbench-0.5.0/src/pluginbench/vendor/ECHARTS-NOTICE +5 -0
- pluginbench-0.5.0/src/pluginbench/vendor/ZRENDER-LICENSE +29 -0
- pluginbench-0.5.0/src/pluginbench/vendor/echarts.min.js +48 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Filip Gutica
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: pluginbench
|
|
3
|
+
Version: 0.5.0
|
|
4
|
+
Summary: Test whether skills help coding agents make fewer mistakes.
|
|
5
|
+
Project-URL: Homepage, https://github.com/filipgutica/pluginbench
|
|
6
|
+
Project-URL: Documentation, https://github.com/filipgutica/pluginbench/blob/main/docs/running-evaluations.md
|
|
7
|
+
Project-URL: Repository, https://github.com/filipgutica/pluginbench
|
|
8
|
+
Project-URL: Issues, https://github.com/filipgutica/pluginbench/issues
|
|
9
|
+
Author: Filip Gutica
|
|
10
|
+
License-Expression: Apache-2.0 AND BSD-3-Clause AND 0BSD
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: src/pluginbench/vendor/ECHARTS-LICENSE
|
|
13
|
+
License-File: src/pluginbench/vendor/ECHARTS-NOTICE
|
|
14
|
+
License-File: src/pluginbench/vendor/ZRENDER-LICENSE
|
|
15
|
+
Keywords: benchmark,coding agents,evaluation,plugins,skills
|
|
16
|
+
Classifier: Development Status :: 4 - Beta
|
|
17
|
+
Classifier: Environment :: Console
|
|
18
|
+
Classifier: Intended Audience :: Developers
|
|
19
|
+
Classifier: Operating System :: MacOS
|
|
20
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
21
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
23
|
+
Classifier: Topic :: Software Development :: Testing
|
|
24
|
+
Requires-Python: >=3.12
|
|
25
|
+
Requires-Dist: harbor==0.24.0
|
|
26
|
+
Requires-Dist: pydantic<3,>=2.11
|
|
27
|
+
Requires-Dist: pyyaml<7,>=6.0.2
|
|
28
|
+
Requires-Dist: typer<1,>=0.16
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: build<2,>=1.3; extra == 'dev'
|
|
31
|
+
Requires-Dist: mypy<2,>=1.17; extra == 'dev'
|
|
32
|
+
Requires-Dist: pytest<9,>=8.4; extra == 'dev'
|
|
33
|
+
Requires-Dist: ruff<0.16,>=0.15; extra == 'dev'
|
|
34
|
+
Requires-Dist: types-pyyaml<7,>=6.0.12; extra == 'dev'
|
|
35
|
+
Description-Content-Type: text/markdown
|
|
36
|
+
|
|
37
|
+
# PluginBench
|
|
38
|
+
|
|
39
|
+
**Are these skills, plugins, or instructions worth using?**
|
|
40
|
+
|
|
41
|
+
PluginBench gives a coding agent the same tasks in several arms: one with no added guidance ("vanilla"), and one for each set of guidance you want to test.
|
|
42
|
+
The harness, model, reasoning effort, and tasks stay fixed, so the guidance is the only difference.
|
|
43
|
+
It then compares correctness, tokens, and the code each attempt added.
|
|
44
|
+
|
|
45
|
+
## What you get
|
|
46
|
+
|
|
47
|
+
- **Arms.** Vanilla is always included. Each *treatment* is a named set of instruction files, skills, or plugins that you declare in the config. Every treatment is compared with vanilla.
|
|
48
|
+
- **Attempts.** Each task runs once per arm and repeat, in a fresh Docker container, through Harbor 0.24.0. The task's own verifier decides pass or fail.
|
|
49
|
+
- **Measures.** You select them in the config:
|
|
50
|
+
|
|
51
|
+
| Measurement | What it counts | Extra requirement |
|
|
52
|
+
| --- | --- | --- |
|
|
53
|
+
| `tokens` | Input, cached, output, and reasoning tokens, and coding time | None |
|
|
54
|
+
| `lines` | Source and test lines added and removed | None |
|
|
55
|
+
| `cyclomatic`, `cognitive` | Complexity the attempt added | An analyzer for the task's language |
|
|
56
|
+
| `dead_code` | Unused code the attempt introduced | An analyzer for the task's language |
|
|
57
|
+
| `coverage` | How much of the added code the attempt's own tests run | A coverage command for the task image |
|
|
58
|
+
| `review` | Findings from an independent AI review with fixed criteria | A `reviewer` block in the config |
|
|
59
|
+
|
|
60
|
+
- **Report.** `runs/<run>/report/report.html` compares the arms, with each task one click away. `results.json` holds the metrics and deltas against vanilla. `results.csv` holds each measurement. Failed attempts and missing measurements stay visible.
|
|
61
|
+
|
|
62
|
+
When a task ships a reference solution (`solution/solution.patch`), code measures are also shown as a ratio to that reference. [What each measure means](docs/measurement-spec.md).
|
|
63
|
+
|
|
64
|
+
## Requirements
|
|
65
|
+
|
|
66
|
+
PluginBench runs on Linux or macOS. Every run needs:
|
|
67
|
+
|
|
68
|
+
| Tool | Version | Why |
|
|
69
|
+
| --- | --- | --- |
|
|
70
|
+
| Python | 3.12 or later | Runs PluginBench |
|
|
71
|
+
| Git | Any recent | Task sources and patches |
|
|
72
|
+
| Docker | Linux containers on a local Unix socket, with Compose and Buildx | Each attempt and its verifier run in containers |
|
|
73
|
+
| Codex CLI | Exactly 0.162.1 or 0.167.0, logged in | Coding agent. PluginBench checks the `codex` on your `PATH` and copies its login from `~/.codex/auth.json`. Other versions fail `check`. |
|
|
74
|
+
|
|
75
|
+
Some measures and commands need more:
|
|
76
|
+
|
|
77
|
+
| Needed for | Tool |
|
|
78
|
+
| --- | --- |
|
|
79
|
+
| JS/TS complexity and dead code | Node (this repository pins 22.20), Corepack, and Fallow 3.18.0 |
|
|
80
|
+
| Python, Go, Rust analysis | Pinned analyzers; see [Measurements](docs/running-evaluations.md#measurements) |
|
|
81
|
+
| `coverage` | A coverage command that the task image supports |
|
|
82
|
+
| Analysis measures that run on the host, and `review` | Bubblewrap (`bwrap` on `PATH`) on Linux, or `sandbox-exec` on macOS |
|
|
83
|
+
| `pluginbench tasks pick` | `fzf`, and for `--copy` a clipboard tool (`pbcopy`, `wl-copy`, `xclip`, or `xsel`) |
|
|
84
|
+
|
|
85
|
+
## Install
|
|
86
|
+
|
|
87
|
+
There is no registry release yet. Install from a clone:
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
git clone https://github.com/filipgutica/pluginbench.git
|
|
91
|
+
cd pluginbench
|
|
92
|
+
python3 -m venv .venv
|
|
93
|
+
source .venv/bin/activate
|
|
94
|
+
pip install -e .
|
|
95
|
+
pluginbench --version
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Quickstart
|
|
99
|
+
|
|
100
|
+
This run uses one public DeepSWE task, vanilla only, and one repeat. It needs no private input.
|
|
101
|
+
|
|
102
|
+
1. Save this as `evaluation.yaml`:
|
|
103
|
+
|
|
104
|
+
```yaml
|
|
105
|
+
name: First run
|
|
106
|
+
runner:
|
|
107
|
+
harness: codex
|
|
108
|
+
model: gpt-6.1-sol
|
|
109
|
+
reasoning: medium
|
|
110
|
+
treatments: {} # vanilla only
|
|
111
|
+
tasks:
|
|
112
|
+
urls:
|
|
113
|
+
- https://github.com/datacurve-ai/deep-swe/tree/0b9fabbb63b9104d678fe965e1632f2dd9eaa2ea/tasks/testem-per-launcher-reports
|
|
114
|
+
measurements: [tokens, lines]
|
|
115
|
+
repeats: 1
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
2. Run every check that needs no model:
|
|
119
|
+
|
|
120
|
+
```sh
|
|
121
|
+
pluginbench check evaluation.yaml
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
This downloads and prepares the task, checks Docker capacity, the Codex version, and the verifier, then prints a readiness table.
|
|
125
|
+
It shows whether each vanilla attempt is already cached, writes `runs/check-<timestamp>/check.json`, and exits with code 2 if the run would fail or lose data.
|
|
126
|
+
If it reports that `jobs` exceeds Docker capacity, add `jobs: 1` to the config or give Docker more CPU and memory.
|
|
127
|
+
|
|
128
|
+
3. See the plan and the call count:
|
|
129
|
+
|
|
130
|
+
```sh
|
|
131
|
+
pluginbench run evaluation.yaml --dry-run
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
The `Coding attempts` line shows one attempt for this config. It counts attempts, not model requests: subagents are on by default, so one attempt can make several requests.
|
|
135
|
+
|
|
136
|
+
4. Start the run. **This makes paid model calls with your Codex login.**
|
|
137
|
+
|
|
138
|
+
```sh
|
|
139
|
+
pluginbench run evaluation.yaml
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
`run` prints the plan and asks `Start evaluation?` (`--yes` skips the question).
|
|
143
|
+
It then runs the same checks as `check`, starts the run in the background, and prints the run directory, for example `runs/20261110T101500123456Z`.
|
|
144
|
+
|
|
145
|
+
5. Follow it:
|
|
146
|
+
|
|
147
|
+
```sh
|
|
148
|
+
pluginbench status runs/<run> --watch
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
`status` shows the phase, attempts and outcomes per arm, tokens, vanilla reuse, and measures. It never writes.
|
|
152
|
+
|
|
153
|
+
6. Open `runs/<run>/report/report.html` when the phase is `complete`.
|
|
154
|
+
|
|
155
|
+
Paths under `runs/` are relative to the directory where you run the command. For a fuller template, `pluginbench init template.yaml` writes a starter config with `/path/to` placeholders to replace.
|
|
156
|
+
|
|
157
|
+
## Test your own guidance
|
|
158
|
+
|
|
159
|
+
A *treatment* is the guidance you want to test. It can be instruction files, skills, plugins, or a mix. Every treatment runs on the same tasks as vanilla, so you can see what each one changes.
|
|
160
|
+
|
|
161
|
+
1. Put the guidance next to your config. Paths in the config are relative to the config file.
|
|
162
|
+
|
|
163
|
+
```text
|
|
164
|
+
my-eval/
|
|
165
|
+
├── evaluation.yaml
|
|
166
|
+
├── AGENTS.md # instructions: UTF-8 .md or .txt files, 32 KiB in all
|
|
167
|
+
├── skills/
|
|
168
|
+
│ └── write-tests/
|
|
169
|
+
│ └── SKILL.md # a skill
|
|
170
|
+
└── review-plugin/
|
|
171
|
+
├── .codex-plugin/
|
|
172
|
+
│ └── plugin.json # a Codex plugin
|
|
173
|
+
└── skills/
|
|
174
|
+
└── self-review/
|
|
175
|
+
└── SKILL.md
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
Each `SKILL.md` starts with YAML front matter that has a kebab-case `name` and a `description`:
|
|
179
|
+
|
|
180
|
+
```markdown
|
|
181
|
+
---
|
|
182
|
+
name: write-tests
|
|
183
|
+
description: Add focused tests for every behaviour you change.
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
Write one test per changed behaviour. Run it and confirm it fails without your change.
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
A plugin needs a manifest with a kebab-case `name`. Its skills go in `skills/`:
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"name": "review-plugin",
|
|
194
|
+
"version": "0.1.0",
|
|
195
|
+
"description": "Review your own diff before you finish."
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
2. Declare one treatment per thing you want to compare:
|
|
200
|
+
|
|
201
|
+
```yaml
|
|
202
|
+
name: Guidance comparison
|
|
203
|
+
runner:
|
|
204
|
+
harness: codex
|
|
205
|
+
model: gpt-6.1-sol
|
|
206
|
+
reasoning: medium
|
|
207
|
+
treatments:
|
|
208
|
+
instructions:
|
|
209
|
+
guidance: [./AGENTS.md]
|
|
210
|
+
test-skill:
|
|
211
|
+
skills: [./skills] # one skill folder, or a folder of skills
|
|
212
|
+
review-plugin:
|
|
213
|
+
plugins: [./review-plugin]
|
|
214
|
+
tasks:
|
|
215
|
+
urls:
|
|
216
|
+
- https://github.com/datacurve-ai/deep-swe/tree/0b9fabbb63b9104d678fe965e1632f2dd9eaa2ea/tasks/testem-per-launcher-reports
|
|
217
|
+
measurements: [tokens, lines]
|
|
218
|
+
repeats: 1
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
One treatment can also combine them, for example `guidance` and `skills` together.
|
|
222
|
+
|
|
223
|
+
3. Check it, then look at the plan:
|
|
224
|
+
|
|
225
|
+
```sh
|
|
226
|
+
pluginbench check evaluation.yaml
|
|
227
|
+
pluginbench run evaluation.yaml --dry-run
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
The plan lists the arms `vanilla, instructions, test-skill, review-plugin` and 4 coding attempts: one per arm, task, and repeat. Add tasks and `repeats: 3` or more before you trust a difference.
|
|
231
|
+
|
|
232
|
+
4. Run it with `pluginbench run evaluation.yaml`, as in the quickstart. The report compares each treatment with vanilla.
|
|
233
|
+
|
|
234
|
+
Treatments need the Codex harness. Instruction files become the agent's private `AGENTS.md`; they are never added to the task prompt or to the repository. Skills and plugins are copied whole, including their scripts, except Git internals; symlinks, special files, and `.env` files are refused. Skill dependencies, MCP servers, apps, custom agents, commands, plugin dependencies, and hooks other than synchronous command hooks are not supported yet, and a treatment that declares one stops the run before any model call. Before coding, PluginBench checks that Codex found every declared skill. That proves the skill was available, not that the agent used it. [Native treatments](docs/running-evaluations.md#native-treatments).
|
|
235
|
+
|
|
236
|
+
## Commands
|
|
237
|
+
|
|
238
|
+
Every setting lives in the config. Flags only control how a command runs.
|
|
239
|
+
|
|
240
|
+
| Command | What it does | Model calls |
|
|
241
|
+
| --- | --- | --- |
|
|
242
|
+
| `init [path]` | Write a starter config; never overwrites | No |
|
|
243
|
+
| `check <config>` | Prepare tasks and run every check that needs no model | No |
|
|
244
|
+
| `run <config>` | Start a run; `--dry-run` shows the plan, `--foreground` stays in the terminal, `--notify` sends desktop notifications | Yes |
|
|
245
|
+
| `run <run-dir>` | Resume a stopped or crashed run | Yes |
|
|
246
|
+
| `status <run-dir>` | Show progress; `--watch` redraws, `--json` prints one object | No |
|
|
247
|
+
| `stop <run-dir>` | Stop the run's own process group | No |
|
|
248
|
+
| `report <run-dir>` | Rebuild the report from saved evidence | No |
|
|
249
|
+
| `review <run-dir> --revision <name>` | Review every submission again with the same reviewer | Yes |
|
|
250
|
+
| `compare <run-dir>... --gates <file>` | Print measure and gate tables across runs | No |
|
|
251
|
+
| `tasks pick --dataset <name>` | Choose tasks with fzf and print a pinned `tasks:` block | No |
|
|
252
|
+
| `judge prepare`, `judge run`, `judge tally` | Blind pairwise judging of two arms | `judge run` only |
|
|
253
|
+
|
|
254
|
+
## Configure an evaluation
|
|
255
|
+
|
|
256
|
+
**Tasks.** Use one source: a Harbor `dataset` with `version` and `ids`, GitHub task-folder `urls`, or a local `source` with `ids`. PluginBench accepts single-step Harbor tasks with a Linux CPU environment and a separate verifier. To browse DeepSWE, run `pluginbench tasks pick --dataset datacurve/deep-swe-1-1 --copy`, press Tab to select several tasks, and paste the YAML it prints. [Choose inputs](docs/running-evaluations.md#choose-inputs).
|
|
257
|
+
|
|
258
|
+
**Treatments.** Each treatment lists `guidance` (instruction files), `skills`, or `plugins`; see [Test your own guidance](#test-your-own-guidance). The task prompt is the same for every arm.
|
|
259
|
+
|
|
260
|
+
**Measurements.** Before any paid call, PluginBench runs each selected collector twice on the starting code. A measure with no collector for a task is `not_configured`, and one whose collector fails its probe is `broken`. That task is then not measured for it, and the run continues, as long as another task can measure it. A measure that is ready on no task stops the run. With `measurement_settings.require_ready: true`, any such task stops the run. Selecting `review` requires a `reviewer` block. [Measurements](docs/running-evaluations.md#measurements).
|
|
261
|
+
|
|
262
|
+
**Concurrency.** `jobs` defaults to 2 and accepts 1 to 4. A value above Docker capacity fails the check; PluginBench does not lower it. [Concurrency and resume](docs/running-evaluations.md#concurrency-and-resume).
|
|
263
|
+
|
|
264
|
+
## Stop, resume, and reuse
|
|
265
|
+
|
|
266
|
+
- `pluginbench stop runs/<run>` stops new attempts. With `jobs` above 1, attempts already coding finish and are kept. With `jobs: 1`, the attempt in progress is interrupted, and a resume codes its slot again with a new attempt.
|
|
267
|
+
- `pluginbench run runs/<run>` resumes. A run that was killed, for example by a host shutdown, shows `interrupted`, and `status` prints this command. Complete attempts are kept and never coded again. An attempt cut off mid-call is recorded as `discarded-interrupted` and a new attempt takes its slot. Containers the killed attempt left running are stopped before coding resumes, and `status` names them until then. Resume cannot repair a failing solution.
|
|
268
|
+
- If Codex fails before its first model turn, for example during a network outage, the run stops instead of scoring the attempt. Resume when Codex is reachable.
|
|
269
|
+
- Vanilla attempts are cached in `$XDG_CACHE_HOME/pluginbench` (default `~/.cache/pluginbench`) and reused by any later run with the same task, model, and settings. Grading and measures run again. Reports mark reused attempts. [Baselines and reports](docs/running-evaluations.md#baselines-and-reports).
|
|
270
|
+
|
|
271
|
+
## Compare and judge
|
|
272
|
+
|
|
273
|
+
- `pluginbench compare` reads saved reports and applies gates you define, such as "no fewer passes than vanilla" or "at most 1.3 times the tokens". [Compare runs](docs/running-evaluations.md#compare-runs).
|
|
274
|
+
- `pluginbench judge` asks blind judges to choose between two arms' submissions for the same task and repeat. [Judging](docs/running-evaluations.md#judging).
|
|
275
|
+
|
|
276
|
+
## Limits
|
|
277
|
+
|
|
278
|
+
- A pass means the task's verifier passed. Task checks do not prove that every behavior is preserved.
|
|
279
|
+
- Discovery proves that a skill was available, not that the model used it.
|
|
280
|
+
- Smaller numbers alone do not prove better work. Coverage does not prove that assertions are useful.
|
|
281
|
+
- Unknown values are never shown as zero.
|
|
282
|
+
- Reused vanilla attempts are not fresh independent samples.
|
|
283
|
+
- A measure that is `broken` on a task is not measured for that task. `check` warns, and the report shows it as unavailable there. With `measurement_settings.require_ready: true`, the check stops instead. A measure that is ready on no task always stops the run.
|
|
284
|
+
- PluginBench executes model-generated code. Use trusted tasks, images, and treatments on a trusted machine. See [Security](SECURITY.md).
|
|
285
|
+
|
|
286
|
+
## More
|
|
287
|
+
|
|
288
|
+
- [Evaluation details](docs/running-evaluations.md): every setting, check, and output
|
|
289
|
+
- [Config reference](docs/config-reference.md): every config key, its type, default, and meaning
|
|
290
|
+
- [Metrics](docs/metrics.md): what each measure means and its name in a gates file
|
|
291
|
+
- [Reproduce a result](docs/reproduce.md): what a run pins, and a worked example
|
|
292
|
+
- [Measurement specification](docs/measurement-spec.md)
|
|
293
|
+
- [Security](SECURITY.md)
|
|
294
|
+
- [License: Apache-2.0](LICENSE)
|