researchos-ci 0.4.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.
- researchos_ci-0.4.0/.gitignore +30 -0
- researchos_ci-0.4.0/LICENSE +202 -0
- researchos_ci-0.4.0/NOTICE +9 -0
- researchos_ci-0.4.0/PKG-INFO +227 -0
- researchos_ci-0.4.0/README.md +213 -0
- researchos_ci-0.4.0/pyproject.toml +33 -0
- researchos_ci-0.4.0/src/researchos/__init__.py +6 -0
- researchos_ci-0.4.0/src/researchos/__main__.py +4 -0
- researchos_ci-0.4.0/src/researchos/cache_auth.py +36 -0
- researchos_ci-0.4.0/src/researchos/cli.py +246 -0
- researchos_ci-0.4.0/src/researchos/conductor/__init__.py +17 -0
- researchos_ci-0.4.0/src/researchos/conductor/agent_adapter.py +55 -0
- researchos_ci-0.4.0/src/researchos/conductor/builder.py +149 -0
- researchos_ci-0.4.0/src/researchos/conductor/cli.py +312 -0
- researchos_ci-0.4.0/src/researchos/conductor/events.py +195 -0
- researchos_ci-0.4.0/src/researchos/conductor/providers.py +151 -0
- researchos_ci-0.4.0/src/researchos/conductor/runtime.py +458 -0
- researchos_ci-0.4.0/src/researchos/conductor/secrets.py +141 -0
- researchos_ci-0.4.0/src/researchos/conductor/venice_adapter.py +122 -0
- researchos_ci-0.4.0/src/researchos/dataflow.py +76 -0
- researchos_ci-0.4.0/src/researchos/domain_checks.py +171 -0
- researchos_ci-0.4.0/src/researchos/evidence.py +154 -0
- researchos_ci-0.4.0/src/researchos/initialization.py +73 -0
- researchos_ci-0.4.0/src/researchos/pack_tools.py +86 -0
- researchos_ci-0.4.0/src/researchos/packs/ml/checks/manifest.yaml +43 -0
- researchos_ci-0.4.0/src/researchos/packs/ml/fixtures.yaml +70 -0
- researchos_ci-0.4.0/src/researchos/packs/quant-finance/checks/manifest.yaml +163 -0
- researchos_ci-0.4.0/src/researchos/packs/quant-finance/fixtures.yaml +282 -0
- researchos_ci-0.4.0/src/researchos/packs/quant-finance/schemas/assumptions.yaml +8 -0
- researchos_ci-0.4.0/src/researchos/packs/quant-finance/vocabulary/errors.yaml +14 -0
- researchos_ci-0.4.0/src/researchos/packs/quant-finance/vocabulary/requirements.yaml +9 -0
- researchos_ci-0.4.0/src/researchos/process.py +17 -0
- researchos_ci-0.4.0/src/researchos/quant/__init__.py +1 -0
- researchos_ci-0.4.0/src/researchos/quant/verifier.py +25 -0
- researchos_ci-0.4.0/src/researchos/report_server.py +83 -0
- researchos_ci-0.4.0/src/researchos/reporting.py +83 -0
- researchos_ci-0.4.0/src/researchos/reproduction.py +166 -0
- researchos_ci-0.4.0/src/researchos/rules.py +78 -0
- researchos_ci-0.4.0/src/researchos/skill.py +90 -0
- researchos_ci-0.4.0/src/researchos/statistics.py +128 -0
- researchos_ci-0.4.0/src/researchos/verifier.py +535 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
.pytest_cache/
|
|
5
|
+
.mypy_cache/
|
|
6
|
+
.ruff_cache/
|
|
7
|
+
.coverage
|
|
8
|
+
htmlcov/
|
|
9
|
+
|
|
10
|
+
# Virtualenvs
|
|
11
|
+
.venv/
|
|
12
|
+
venv/
|
|
13
|
+
|
|
14
|
+
# OS/editor
|
|
15
|
+
.DS_Store
|
|
16
|
+
.idea/
|
|
17
|
+
.vscode/
|
|
18
|
+
|
|
19
|
+
# Local secrets and env
|
|
20
|
+
.env
|
|
21
|
+
.env.*
|
|
22
|
+
!.env.example
|
|
23
|
+
*.pem
|
|
24
|
+
*.key
|
|
25
|
+
|
|
26
|
+
# Generated demo artifacts
|
|
27
|
+
.researchos/
|
|
28
|
+
dist/
|
|
29
|
+
examples/quant-failing-pr/results/
|
|
30
|
+
examples/quant-failing-pr/researchos-verdict.txt
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
ResearchOS / Research CI
|
|
2
|
+
|
|
3
|
+
This repository is an original Research CI MVP inspired by the public Apache-2.0
|
|
4
|
+
get-physics-done project from Physical Superintelligence PBC (PSI):
|
|
5
|
+
https://github.com/psi-oss/get-physics-done
|
|
6
|
+
|
|
7
|
+
No GPD source files are vendored in this MVP. Before extracting or adapting GPD
|
|
8
|
+
source directly, preserve Apache-2.0 license/notice obligations and complete a
|
|
9
|
+
provenance/dependency audit.
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: researchos-ci
|
|
3
|
+
Version: 0.4.0
|
|
4
|
+
Summary: Research CI verifier with evidence-bound quant and ML domain checks
|
|
5
|
+
Project-URL: Repository, https://github.com/demirelo/researchos
|
|
6
|
+
Project-URL: Issues, https://github.com/demirelo/researchos/issues
|
|
7
|
+
Author: ResearchOS
|
|
8
|
+
License: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
License-File: NOTICE
|
|
11
|
+
Requires-Python: >=3.11
|
|
12
|
+
Requires-Dist: pyyaml>=6.0
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
# ResearchOS / Research CI
|
|
16
|
+
|
|
17
|
+
**Verify claims and evidence in AI-assisted computational research.**
|
|
18
|
+
|
|
19
|
+
Research CI is the main product. It checks declared claims, linked evidence,
|
|
20
|
+
domain rules and optional reproduction before a research change passes CI.
|
|
21
|
+
The optional Conductor adds approved Builder steps and independent review around
|
|
22
|
+
that verification gate.
|
|
23
|
+
|
|
24
|
+
A passing configuration check is separate from a reproduced, supported claim.
|
|
25
|
+
The verdict `proved` means a declared computational predicate passed the configured
|
|
26
|
+
checks. It does not establish general scientific truth.
|
|
27
|
+
|
|
28
|
+
## Implementation status
|
|
29
|
+
|
|
30
|
+
Version **0.4.0** extends the implementation of all 12 improvement ideas from
|
|
31
|
+
[the proposal](https://researchos-10x-ideas-jai3.pages.grok.bot/).
|
|
32
|
+
[PR #16](https://github.com/demirelo/researchos/pull/16) merged the initial implementation.
|
|
33
|
+
This update completes the remaining code features and adds publishing workflows.
|
|
34
|
+
Registry publication and public report deployment remain separate service actions.
|
|
35
|
+
|
|
36
|
+
| Idea | Current implementation | Operating limit |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| GitHub Action | Sticky PR comment, Check Run, line annotations, job summary and report artifacts | Code scanning must be enabled before GitHub can accept SARIF uploads |
|
|
39
|
+
| Finding guidance | Shared reasons, required actions, config examples, `explain` and print-only `--fix` | Suggested fixes require review; they do not create evidence |
|
|
40
|
+
| Packaged domain packs | Quant and ML resources, verified wheel/source builds and GitHub/PyPI release workflow | PyPI requires the owning account to configure its trusted publisher |
|
|
41
|
+
| Claim extraction | Draft claims from Markdown, notebook Markdown and PR text; optional model review | Claims remain proposed until a person reviews them and links evidence |
|
|
42
|
+
| Reproduction | Explicit Docker execution, fresh outputs, timeouts and authenticated cache for pinned image digests | Experiments must supply their dependencies and reproduction scripts |
|
|
43
|
+
| Evidence binding | Scalar and interval predicates, percentile/basic bootstrap, tolerances, artifact hashes and fresh-result comparison | Sampling assumptions and interval coverage require review |
|
|
44
|
+
| Verdict semantics | Supported reproduced keystones can be terminal; valid contradictory results can be falsified | Skipped reproduction and legacy self-attestations remain non-terminal |
|
|
45
|
+
| Builder loop | Approved worktree edits, Venice and Claude Code adapters, independent review, new verification and iteration checkpoints | Custom adapters must enforce their provider budget |
|
|
46
|
+
| Quant checks | Typed assumptions, bounded def/use dataflow, computed pairing permutation controls and advisory deflated Sharpe | Dynamic Python flows and experiment refits require explicit project protocols |
|
|
47
|
+
| Reports and badge | Static reports, HTTP report/badge endpoint, checksummed sites and Pages deployment workflow | [Synthetic demo is live](https://demirelo.github.io/researchos/); real reports require an approved destination |
|
|
48
|
+
| ML and pack SDK | Split hashes/membership, seed results, baseline parity and 12 declarative SDK operators for config or reproduced metrics | Custom fixture execution requires an explicit Docker or trusted-host flag |
|
|
49
|
+
| Event and CLI consistency | Incremental reads, persisted settings, redirects, request recovery and durable cost records | Uncertain paid attempts require reconciliation before retry |
|
|
50
|
+
|
|
51
|
+
See the [implementation and validation record](docs/IMPLEMENTATION_10X.md) for
|
|
52
|
+
check details and the [workflow guide](docs/USAGE_10X.md) for configuration.
|
|
53
|
+
|
|
54
|
+
## Requirements and installation
|
|
55
|
+
|
|
56
|
+
Use Python **3.11+**. The examples below use [`uv`](https://docs.astral.sh/uv/).
|
|
57
|
+
Docker must be running when you request container reproduction. Prepare an image
|
|
58
|
+
with the experiment dependencies; reproduction does not install them.
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
git clone https://github.com/demirelo/researchos.git
|
|
62
|
+
cd researchos
|
|
63
|
+
uv sync
|
|
64
|
+
uv run researchos --version
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Build and install a local wheel:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
uv build --clear
|
|
71
|
+
python3.11 -m venv /tmp/researchos-venv
|
|
72
|
+
/tmp/researchos-venv/bin/python -m pip install dist/researchos_ci-0.4.0-py3-none-any.whl
|
|
73
|
+
/tmp/researchos-venv/bin/researchos --version
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
The distribution name is `researchos-ci`; the command and Python import remain
|
|
77
|
+
`researchos`. The wheel includes both domain packs. Version 0.4.0 was built and tested locally;
|
|
78
|
+
this change does not publish it to PyPI or create a downloadable release.
|
|
79
|
+
|
|
80
|
+
## Verify a project
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
uv run researchos verify --ci examples/quant-failing-pr
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
The bundled quant fixture is deliberately incomplete. Expect a non-zero exit
|
|
87
|
+
and blocking findings. Verification does **not execute project code by default**.
|
|
88
|
+
|
|
89
|
+
Request restricted Docker reproduction explicitly:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
uv run researchos verify --ci --reproduce --timeout 600 \
|
|
93
|
+
--image python:3.12-slim /path/to/project
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Docker reproduction disables network access, removes inherited environment
|
|
97
|
+
variables, uses a read-only root filesystem and enforces resource limits.
|
|
98
|
+
Pin the image digest to enable authenticated reproduction caching.
|
|
99
|
+
`--unsafe-local` runs trusted project code on the host with no filesystem or
|
|
100
|
+
network isolation.
|
|
101
|
+
|
|
102
|
+
Declare claims and evidence in `researchos.yaml`. Supply a reproduction script
|
|
103
|
+
and fresh output files when you need a reproduced verdict. See
|
|
104
|
+
[structured claims and reproduction](docs/USAGE_10X.md) and
|
|
105
|
+
[statistical evidence and controls](docs/STATISTICAL_CHECKS.md).
|
|
106
|
+
|
|
107
|
+
## Extract claims, inspect findings and generate reports
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
uv run researchos init /path/to/project --domain ml
|
|
111
|
+
uv run researchos explain quant.transaction_costs_present
|
|
112
|
+
uv run researchos verify --ci --json-output verdict.json /path/to/project
|
|
113
|
+
uv run researchos report verdict.json --output report/index.html \
|
|
114
|
+
--badge-output report/claims.svg
|
|
115
|
+
uv run researchos pack test quant-finance
|
|
116
|
+
uv run researchos pack test ml
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
`init` writes `researchos.draft.yaml` with proposed claims and candidate result
|
|
120
|
+
files. Review the draft and link measured evidence before accepting it.
|
|
121
|
+
`--fix` prints configuration examples for review; it does not edit the project
|
|
122
|
+
or invent measurements. Reports and badges remain local until you publish them.
|
|
123
|
+
Serve a live report and badge with `researchos report verdict.json --serve`, or
|
|
124
|
+
create a deployment directory with `--site-dir public-report`. See
|
|
125
|
+
[report hosting and releases](docs/PUBLISHING.md) and the
|
|
126
|
+
[pack rule reference](docs/PACK_RULES.md).
|
|
127
|
+
|
|
128
|
+
## GitHub integration
|
|
129
|
+
|
|
130
|
+
The [composite Action](docs/GITHUB_ACTION.md) verifies a project and can publish
|
|
131
|
+
one sticky bot comment, a Check Run and line annotations. It also writes JSON,
|
|
132
|
+
SARIF, Markdown, HTML and SVG files for artifact upload. Fork PRs receive no
|
|
133
|
+
privileged publication or project-code execution.
|
|
134
|
+
|
|
135
|
+
The repository workflows check tests, secrets, repository hygiene and the
|
|
136
|
+
expected-failure fixture. A separate maintainer smoke workflow tests a synthetic
|
|
137
|
+
project. Its comment and Check Run use a separate identity so that fixture
|
|
138
|
+
success cannot replace a project verdict.
|
|
139
|
+
|
|
140
|
+
Code scanning is disabled for this repository as of 6 November 2026. SARIF remains
|
|
141
|
+
available in report artifacts; the smoke workflow skips code-scanning upload
|
|
142
|
+
when the service is unavailable.
|
|
143
|
+
|
|
144
|
+
## Optional Conductor and model providers
|
|
145
|
+
|
|
146
|
+
The Conductor records verification results, model proposals, director decisions,
|
|
147
|
+
Builder diffs, review results and costs in an append-only event log.
|
|
148
|
+
Venice is the primary documented model path. Set `VENICE_API_KEY` through your
|
|
149
|
+
environment, an ignored `.env`/`.env.local`, or the supported macOS Keychain entry.
|
|
150
|
+
Do not put credentials in prompts, commits or logs.
|
|
151
|
+
|
|
152
|
+
Start a model-assisted planning run:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
uv run researchos conductor start --project /path/to/project \
|
|
156
|
+
--goal 'Resolve the reproduction blocker' \
|
|
157
|
+
--mode venice --model qwen3-235b-a22b-instruct-2507 --budget-usd 2
|
|
158
|
+
uv run researchos conductor progress
|
|
159
|
+
uv run researchos conductor approve next
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Planning alone does not configure a coding agent. For approved file edits and
|
|
163
|
+
independent review, configure both native adapters:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
uv run researchos conductor start --project /path/to/project \
|
|
167
|
+
--goal 'Resolve the reproduction blocker' \
|
|
168
|
+
--mode venice --model qwen3-235b-a22b-instruct-2507 \
|
|
169
|
+
--builder-command '["/ABS/VENV/bin/python","-m","researchos.conductor.venice_adapter"]' \
|
|
170
|
+
--adversary-command '["/ABS/VENV/bin/python","-m","researchos.conductor.venice_adapter"]' \
|
|
171
|
+
--allow-project-code-execution --budget-usd 2 --iteration-limit 2 \
|
|
172
|
+
--execution-timeout 600
|
|
173
|
+
uv run researchos conductor approve next
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Use an absolute path to the Python environment that contains ResearchOS.
|
|
177
|
+
The native Venice adapter loads in isolated mode, receives only its scoped
|
|
178
|
+
provider credential, and applies structured file edits. It does not execute
|
|
179
|
+
model-proposed commands. Docker reproduction runs separately without that key.
|
|
180
|
+
Each further iteration requires approval. No automatic commit or merge occurs.
|
|
181
|
+
|
|
182
|
+
Venice costs derived from the live catalog are labelled estimates, not invoices.
|
|
183
|
+
Missing usage or uncertain completions stop further work for reconciliation.
|
|
184
|
+
OpenRouter PI calls and a Claude Code Builder/reviewer adapter are also supported.
|
|
185
|
+
See the [Builder and provider guide](docs/USAGE_10X.md).
|
|
186
|
+
|
|
187
|
+
`--mode fake` provides deterministic planning guidance with no model calls. Its
|
|
188
|
+
STORM-style events are checklists, not independent model research. Live independent
|
|
189
|
+
review requires a configured review adapter.
|
|
190
|
+
|
|
191
|
+
## Agent guidance
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
uv run researchos skill install claude
|
|
195
|
+
uv run researchos skill install codex --dest .
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
These installers provide guidance for running ResearchOS before an agent reports
|
|
199
|
+
research progress. They do not make unsupported claims pass verification.
|
|
200
|
+
|
|
201
|
+
## Validation
|
|
202
|
+
|
|
203
|
+
Version 0.4.0 passed **156 local tests**, including clean-wheel installation,
|
|
204
|
+
resampling, interval verdicts, SDK rules, dataflow, HTTP and release regressions.
|
|
205
|
+
Astra reviewed the code at medium effort through the local CLI. Six findings
|
|
206
|
+
were corrected; the closure review found no blocking findings. See the
|
|
207
|
+
[completion record](docs/COMPLETION_PLAN.md).
|
|
208
|
+
|
|
209
|
+
Live checks passed Docker isolation and cache reuse, Venice claim-draft review,
|
|
210
|
+
Venice Builder/reviewer execution, conservative Claude review rejection, and
|
|
211
|
+
GitHub comment/check updates, warning annotations and downloaded report artifacts.
|
|
212
|
+
These checks used synthetic projects. They verify the software workflow, not
|
|
213
|
+
real financial or scientific performance.
|
|
214
|
+
|
|
215
|
+
## Project documents
|
|
216
|
+
|
|
217
|
+
- [Workflow and configuration guide](docs/USAGE_10X.md)
|
|
218
|
+
- [GitHub Action setup](docs/GITHUB_ACTION.md)
|
|
219
|
+
- [Implementation and validation record](docs/IMPLEMENTATION_10X.md)
|
|
220
|
+
- [Statistical evidence and controls](docs/STATISTICAL_CHECKS.md)
|
|
221
|
+
- [Pack rule reference](docs/PACK_RULES.md)
|
|
222
|
+
- [Report hosting and releases](docs/PUBLISHING.md)
|
|
223
|
+
- [Positioning](docs/POSITIONING.md)
|
|
224
|
+
- [Domain pack specification](docs/DOMAIN_PACK_SPEC.md)
|
|
225
|
+
- [Open-core boundary](docs/OPEN_CORE_BOUNDARY.md)
|
|
226
|
+
- [Research Conductor design](docs/RESEARCH_CONDUCTOR.md)
|
|
227
|
+
- [STORM integration design](docs/STORM_INTEGRATION.md)
|