fieldtrial 0.1.0__tar.gz

fieldtrial-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Secrets: tokens and credentials stay local
+.env
+.env.*
+!.env.example
+.pypirc
+
+# Python bytecode
+__pycache__/
+*.py[cod]
+
+# Virtual environments (uv)
+.venv/
+venv/
+
+# Build artifacts (uv build / hatchling)
+build/
+dist/
+*.egg-info/
+*.whl
+
+# Test, lint and type-check caches
+.pytest_cache/
+.hypothesis/
+.mypy_cache/
+.ruff_cache/
+.import_linter_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Docs build (mkdocs)
+/site/
+
+# Editors and OS clutter
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db

fieldtrial-0.1.0/CHANGELOG.md

@@ -0,0 +1,86 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Before 1.0,
+minor releases may contain breaking changes.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-02
+
+First release. Studies: design, lock, fill and analyze end to end, run them from a
+phone-friendly operator console or your own runtime, and share a self-contained report.
+
+### Added
+
+- `study.yaml` schema with line-numbered validation errors, and three templates (`basic`,
+  `checkpoint-ladder`, `serving-sweep`).
+- Randomized complete block schedules with Williams-balanced arm order and blind codes.
+  The schedule is identical on every platform and numpy version for a given seed.
+- Locking and amendments: the design, its hash and the schedule are stored in a SQLite
+  database in the study folder; every change is one transaction plus one event-log row.
+- Invalid trials are kept and rescheduled at the end of their block.
+- A simulated runner and auto-operator, and CSV import (all or nothing, `--map`) and
+  CSV/JSONL export.
+- The analysis engine: the primary analysis follows the locked design (McNemar with a Tango
+  interval, CMH, or Cochran's Q with Holm; a threshold test for single-arm studies), with
+  an independent Boschloo/Newcombe sensitivity analysis, stage funnels, time to success,
+  per-condition and per-session tables, drift and invalid-trial checks, deviations and
+  provenance. The `Results` model is versioned, and its JSON schema is published.
+- Report wording from one tested template per situation, and a Markdown report.
+- New statistics: stage distribution and funnel, Brunner–Munzel on stages, success-time
+  curve and bootstrap median time, CMH test, and homogeneity tests for drift.
+- Commands `init`, `validate`, `plan`, `lock`, `amend`, `simulate`, `import`, `export`,
+  `status`, `unblind`, `analyze` and `report`.
+- Documentation: "Running a study" and "Analysis and reports".
+- The operator console (`fieldtrial serve`): start a session with the rig checklist, run
+  trials by blind code with a timer, label the furthest stage, termination and failure tags,
+  undo within 10 seconds, mark invalid trials, correct labels with a logged reason, a live
+  mirror screen, keyboard and foot-pedal keys, light and dark themes. `--lan` serves phones
+  on the local network behind an access token with a QR code.
+- `fieldtrial demo`: a half-run simulated study in the console.
+- REST API v1 with an OpenAPI document, Server-Sent Events, idempotency keys and optimistic
+  concurrency, and `fieldtrial.client`, a dependency-free Python client.
+- Reports list label corrections made after unblinding as deviations.
+- Documentation: "Operator console", "REST API and client" and a phone test checklist.
+- A self-contained HTML report with seven charts (`fieldtrial report`, now the default
+  format, and in the console): no scripts and nothing loaded from other hosts.
+- An example re-analysis of Dream Machines' published pi0.5 fine-tuning results.
+- Documentation: quickstart, concepts, guides (planning, comparing checkpoints, ladders,
+  serving sweeps, LeRobot, openpi, custom runtimes), and screenshots.
+- `CITATION.cff`.
+
+## [0.1.0rc1] - 2026-10-02
+
+Release candidate of 0.1.0, published to PyPI for testing. Its changes are listed under
+0.1.0; the release is identical apart from this changelog.
+
+## [0.1.0a1] - 2026-10-01
+
+First alpha: the statistics core and the calculator commands.
+
+### Added
+
+- `fieldtrial.stats`, the statistics core (numpy and scipy only):
+  - one-arm intervals: Wilson (default), Clopper–Pearson, Jeffreys, Agresti–Coull, and an
+    exact binomial test against a threshold
+  - two independent arms: Newcombe difference CI, Boschloo exact test (primary), Fisher's
+    exact test and the conditional odds ratio
+  - paired designs: exact McNemar, Tango score CI, Cochran's Q with pairwise McNemar
+  - multiplicity adjustments: Holm, Bonferroni, Benjamini–Hochberg
+  - planning: sample size, power and minimum detectable effect (pooled-z, Fleiss
+    continuity-corrected, arcsine; unequal allocation), exact power for Boschloo and
+    McNemar, and a seeded simulation cross-check
+  - Bayesian summaries (descriptive only): P(p_B > p_A) and credible intervals
+- Calculator commands `fieldtrial ci`, `compare`, `paired`, `power`, `mde` and `adjust`,
+  each with `--json` output.
+- Documentation: a statistics reference page per method, a command-line page and the API
+  reference.
+- Project skeleton: packaging, `fieldtrial --version`, CI and the documentation site.
+
+[Unreleased]: https://github.com/rokbenko/fieldtrial/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/rokbenko/fieldtrial/compare/v0.1.0a1...v0.1.0
+[0.1.0rc1]: https://github.com/rokbenko/fieldtrial/compare/v0.1.0a1...v0.1.0rc1
+[0.1.0a1]: https://github.com/rokbenko/fieldtrial/releases/tag/v0.1.0a1

fieldtrial-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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] [name of copyright owner]
+
+   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.

fieldtrial-0.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.5
+Name: fieldtrial
+Version: 0.1.0
+Summary: Find out whether your robot policy actually got better: statistically rigorous real-world evaluation of robot policies.
+Project-URL: Homepage, https://github.com/rokbenko/fieldtrial
+Project-URL: Repository, https://github.com/rokbenko/fieldtrial
+Project-URL: Issues, https://github.com/rokbenko/fieldtrial/issues
+Project-URL: Changelog, https://github.com/rokbenko/fieldtrial/blob/main/CHANGELOG.md
+Author: Rok Benko
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: confidence intervals,hypothesis testing,lerobot,policy evaluation,robot learning,robotics,statistics,vla
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: alembic>=1.13
+Requires-Dist: fastapi>=0.115
+Requires-Dist: jinja2>=3.1
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=1.26
+Requires-Dist: pydantic>=2.7
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qrcode>=7.4
+Requires-Dist: rich>=13.8
+Requires-Dist: scipy>=1.13
+Requires-Dist: sqlalchemy>=2.0.30
+Requires-Dist: sse-starlette>=2.1
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn[standard]>=0.30
+Provides-Extra: dev
+Requires-Dist: httpx>=0.28; extra == 'dev'
+Requires-Dist: hypothesis>=6.130; extra == 'dev'
+Requires-Dist: import-linter>=2.1; extra == 'dev'
+Requires-Dist: mypy>=2.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.16; extra == 'dev'
+Requires-Dist: scipy-stubs>=1.15; extra == 'dev'
+Requires-Dist: statsmodels>=0.14.4; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.6; extra == 'docs'
+Requires-Dist: mkdocs<2,>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.29; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# fieldtrial
+
+**Find out whether your robot policy actually got better.**
+
+[![CI](https://github.com/rokbenko/fieldtrial/actions/workflows/ci.yml/badge.svg)](https://github.com/rokbenko/fieldtrial/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/fieldtrial.svg)](https://pypi.org/project/fieldtrial/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/rokbenko/fieldtrial/blob/main/LICENSE)
+
+fieldtrial is an open-source Python framework for statistically rigorous, real-world
+evaluation of robot policies. LeRobot trains the policy; fieldtrial tells you whether it
+actually got better.
+
+## Why
+
+Real-world evaluation is slow, noisy and ad hoc. With 40 rollouts, the 95% confidence
+interval for a success rate is 12 to 15 percentage points wide on each side, so many apparent
+improvements from a fine-tuning run are just noise. fieldtrial helps at every stage:
+
+- **Before:** how many rollouts do I need? What is the smallest difference this
+  evaluation can detect?
+- **During:** a randomized, blinded schedule, and a phone-friendly operator console that
+  records the outcome, the furthest stage reached and the failure mode of each rollout.
+- **After:** the right statistics for the design (exact tests, paired analyses,
+  multiplicity control), honest wording, and a self-contained report.
+
+## 30-second demo
+
+```console
+$ uvx fieldtrial compare 74/80 91/120
+Arm 1: 74/80 = 92.5% (95% CI 84.6%–96.5%)
+Arm 2: 91/120 = 75.8% (95% CI 67.4%–82.6%)
+Difference +16.7 pp, Newcombe 95% CI [+6.2 pp, +26.0 pp]
+Boschloo p = 0.0020 (two-sided); rejects H0 at α = 0.05
+Fisher p = 0.0022
+
+$ uvx fieldtrial power --p1 0.76 --p2 0.90      # rollouts needed to detect 76% → 90%
+112 per arm (pooled-z)
+
+$ uvx fieldtrial demo                           # a simulated study in the console
+```
+
+`fieldtrial demo` opens a half-run, blinded study with a simulated robot. Run the rest
+from the keyboard (Space, Space, Enter), unblind, and read the report.
+
+<p>
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/console-running.png" alt="The operator console on a phone: a trial in progress with its blind code, timer and a large Stop button" width="260">
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/console-label.png" alt="Labelling a trial: furthest stage reached, why it ended, failure tags" width="260">
+</p>
+<p>
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/report.png" alt="The HTML report: summary, success rate per arm with confidence intervals, primary analysis and a forest plot" width="560">
+</p>
+
+<!-- A short GIF of a trial run in the console goes here. -->
+
+## Quickstart
+
+```console
+$ uv tool install fieldtrial              # or: pip install fieldtrial
+$ fieldtrial init my-study                # writes my-study/study.yaml
+$ fieldtrial plan my-study --baseline 0.75
+$ fieldtrial lock my-study                # freezes the design and randomizes the schedule
+$ fieldtrial serve my-study --lan         # scan the QR code with a phone at the robot
+$ fieldtrial unblind my-study
+$ fieldtrial report my-study              # my-study/reports/report.html
+```
+
+A study is one folder: `study.yaml` (the design) and a SQLite database. Everything is
+local and works offline; fieldtrial sends no telemetry.
+
+- [Documentation](https://rokbenko.github.io/fieldtrial/): quickstart, concepts, guides
+  and a statistics reference.
+- [Re-analysis of Dream Machines' published pi0.5 results](https://github.com/rokbenko/fieldtrial/tree/main/examples/dream-machines-pi05):
+  which of 30 published comparisons the data actually resolve.
+
+## What you get
+
+- **Design:** randomized complete blocks with balanced arm order, blind codes, a design
+  hash, locking and logged amendments.
+- **Console:** sessions with a rig checklist, a timer, stage and failure-tag labels,
+  10-second undo, invalid trials with automatic rescheduling, a live mirror screen,
+  keyboard and foot-pedal keys, LAN access with a QR code.
+- **Analysis:** the primary test follows from the locked design (exact McNemar with a
+  Tango interval, Cochran–Mantel–Haenszel, or Cochran's Q with Holm), plus an
+  independent-samples sensitivity analysis, stage funnels, time to success, drift checks
+  and a list of every deviation from the plan.
+- **Reports:** self-contained HTML with charts, Markdown for pull requests, and a
+  versioned JSON results model.
+- **Integration:** a REST API with a dependency-free Python client for custom runtimes,
+  CSV import and export, and `fieldtrial.stats` as a library.
+
+Every statistical function is tested against an independent reference implementation.
+Reports only describe a difference when the pre-registered test rejects; otherwise they
+say what the study could have detected.
+
+## How it fits with LeRobot and openpi
+
+fieldtrial complements LeRobot and openpi and never forks them. It is not a training
+framework, a simulation benchmark, a robot driver, a labeling platform or a cloud
+service. In manual mode, fieldtrial schedules and records the trials and you run the
+robot however you like. Runners that launch LeRobot rollouts and route openpi traffic for
+real blinding are planned for v0.2; see the
+[roadmap](https://github.com/rokbenko/fieldtrial/blob/main/docs/ROADMAP.md).
+
+## How to cite
+
+If fieldtrial helps your research, please cite it (see
+[CITATION.cff](https://github.com/rokbenko/fieldtrial/blob/main/CITATION.cff)):
+
+```bibtex
+@software{benko_fieldtrial,
+  author  = {Benko, Rok},
+  title   = {fieldtrial: statistically rigorous real-world evaluation for robot policies},
+  url     = {https://github.com/rokbenko/fieldtrial},
+  license = {Apache-2.0}
+}
+```
+
+For evaluation practice in general, see Kress-Gazit et al. (2024), *Robot Learning as an
+Empirical Science: Best Practices for Policy Evaluation*, arXiv:2409.09491.
+
+## Development
+
+See [CONTRIBUTING.md](https://github.com/rokbenko/fieldtrial/blob/main/CONTRIBUTING.md).

fieldtrial-0.1.0/README.md

@@ -0,0 +1,123 @@
+# fieldtrial
+
+**Find out whether your robot policy actually got better.**
+
+[![CI](https://github.com/rokbenko/fieldtrial/actions/workflows/ci.yml/badge.svg)](https://github.com/rokbenko/fieldtrial/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/fieldtrial.svg)](https://pypi.org/project/fieldtrial/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/rokbenko/fieldtrial/blob/main/LICENSE)
+
+fieldtrial is an open-source Python framework for statistically rigorous, real-world
+evaluation of robot policies. LeRobot trains the policy; fieldtrial tells you whether it
+actually got better.
+
+## Why
+
+Real-world evaluation is slow, noisy and ad hoc. With 40 rollouts, the 95% confidence
+interval for a success rate is 12 to 15 percentage points wide on each side, so many apparent
+improvements from a fine-tuning run are just noise. fieldtrial helps at every stage:
+
+- **Before:** how many rollouts do I need? What is the smallest difference this
+  evaluation can detect?
+- **During:** a randomized, blinded schedule, and a phone-friendly operator console that
+  records the outcome, the furthest stage reached and the failure mode of each rollout.
+- **After:** the right statistics for the design (exact tests, paired analyses,
+  multiplicity control), honest wording, and a self-contained report.
+
+## 30-second demo
+
+```console
+$ uvx fieldtrial compare 74/80 91/120
+Arm 1: 74/80 = 92.5% (95% CI 84.6%–96.5%)
+Arm 2: 91/120 = 75.8% (95% CI 67.4%–82.6%)
+Difference +16.7 pp, Newcombe 95% CI [+6.2 pp, +26.0 pp]
+Boschloo p = 0.0020 (two-sided); rejects H0 at α = 0.05
+Fisher p = 0.0022
+
+$ uvx fieldtrial power --p1 0.76 --p2 0.90      # rollouts needed to detect 76% → 90%
+112 per arm (pooled-z)
+
+$ uvx fieldtrial demo                           # a simulated study in the console
+```
+
+`fieldtrial demo` opens a half-run, blinded study with a simulated robot. Run the rest
+from the keyboard (Space, Space, Enter), unblind, and read the report.
+
+<p>
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/console-running.png" alt="The operator console on a phone: a trial in progress with its blind code, timer and a large Stop button" width="260">
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/console-label.png" alt="Labelling a trial: furthest stage reached, why it ended, failure tags" width="260">
+</p>
+<p>
+  <img src="https://raw.githubusercontent.com/rokbenko/fieldtrial/main/docs/assets/report.png" alt="The HTML report: summary, success rate per arm with confidence intervals, primary analysis and a forest plot" width="560">
+</p>
+
+<!-- A short GIF of a trial run in the console goes here. -->
+
+## Quickstart
+
+```console
+$ uv tool install fieldtrial              # or: pip install fieldtrial
+$ fieldtrial init my-study                # writes my-study/study.yaml
+$ fieldtrial plan my-study --baseline 0.75
+$ fieldtrial lock my-study                # freezes the design and randomizes the schedule
+$ fieldtrial serve my-study --lan         # scan the QR code with a phone at the robot
+$ fieldtrial unblind my-study
+$ fieldtrial report my-study              # my-study/reports/report.html
+```
+
+A study is one folder: `study.yaml` (the design) and a SQLite database. Everything is
+local and works offline; fieldtrial sends no telemetry.
+
+- [Documentation](https://rokbenko.github.io/fieldtrial/): quickstart, concepts, guides
+  and a statistics reference.
+- [Re-analysis of Dream Machines' published pi0.5 results](https://github.com/rokbenko/fieldtrial/tree/main/examples/dream-machines-pi05):
+  which of 30 published comparisons the data actually resolve.
+
+## What you get
+
+- **Design:** randomized complete blocks with balanced arm order, blind codes, a design
+  hash, locking and logged amendments.
+- **Console:** sessions with a rig checklist, a timer, stage and failure-tag labels,
+  10-second undo, invalid trials with automatic rescheduling, a live mirror screen,
+  keyboard and foot-pedal keys, LAN access with a QR code.
+- **Analysis:** the primary test follows from the locked design (exact McNemar with a
+  Tango interval, Cochran–Mantel–Haenszel, or Cochran's Q with Holm), plus an
+  independent-samples sensitivity analysis, stage funnels, time to success, drift checks
+  and a list of every deviation from the plan.
+- **Reports:** self-contained HTML with charts, Markdown for pull requests, and a
+  versioned JSON results model.
+- **Integration:** a REST API with a dependency-free Python client for custom runtimes,
+  CSV import and export, and `fieldtrial.stats` as a library.
+
+Every statistical function is tested against an independent reference implementation.
+Reports only describe a difference when the pre-registered test rejects; otherwise they
+say what the study could have detected.
+
+## How it fits with LeRobot and openpi
+
+fieldtrial complements LeRobot and openpi and never forks them. It is not a training
+framework, a simulation benchmark, a robot driver, a labeling platform or a cloud
+service. In manual mode, fieldtrial schedules and records the trials and you run the
+robot however you like. Runners that launch LeRobot rollouts and route openpi traffic for
+real blinding are planned for v0.2; see the
+[roadmap](https://github.com/rokbenko/fieldtrial/blob/main/docs/ROADMAP.md).
+
+## How to cite
+
+If fieldtrial helps your research, please cite it (see
+[CITATION.cff](https://github.com/rokbenko/fieldtrial/blob/main/CITATION.cff)):
+
+```bibtex
+@software{benko_fieldtrial,
+  author  = {Benko, Rok},
+  title   = {fieldtrial: statistically rigorous real-world evaluation for robot policies},
+  url     = {https://github.com/rokbenko/fieldtrial},
+  license = {Apache-2.0}
+}
+```
+
+For evaluation practice in general, see Kress-Gazit et al. (2024), *Robot Learning as an
+Empirical Science: Best Practices for Policy Evaluation*, arXiv:2409.09491.
+
+## Development
+
+See [CONTRIBUTING.md](https://github.com/rokbenko/fieldtrial/blob/main/CONTRIBUTING.md).