sdm-learn 0.1.0__tar.gz

sdm_learn-0.1.0/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to `sdm-learn`. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
+[PEP 440](https://peps.python.org/pep-0440/).
+
+## [0.1.0] - 2026-09-09
+
+The first non-development release. The library was cut down to what the
+paper describes and made to run through one command.
+
+### Added
+- `sdm run --dataset NAME|DIR --algo sdm|base --format ...`: one command for
+  every benchmark and for a directory of your own `train.jsonl` /
+  `test.jsonl` rows (`src/sdm/benchmarks.py`). Each built-in dataset carries
+  the gate settings its protocol uses; flags override them.
+- `--style` / `train(style=...)`: a free-text guide, shown only to the
+  writer, naming the kinds of content the document should use.
+- SEARCH/REPLACE `<patch>` revisions for the `text`, `html`, `image`, and
+  `audio` formats, so a revision costs its difference rather than a rewrite.
+- A `text` format: one plain-text document.
+- `image` format refuses every text element; the picture carries the
+  hypothesis.
+- Gateway knobs: `SDM_TEMPERATURE`, `SDM_EXTRA_PAYLOAD`,
+  `SDM_MAX_COMPLETION_TOKENS`, and a separate writer model or endpoint
+  (`SDM_WRITER_MODEL`, `SDM_WRITER_EFFORT`, `SDM_WRITER_GATEWAY_URL`,
+  `SDM_WRITER_API_KEY`).
+- Writer robustness for small models: lenient edit parsing, one corrected
+  retry on an invalid revision, context-window failures skip the candidate,
+  `proposal_examples` caps the feedback shown per epoch.
+- `reproduce/showcase.py`: an interactive page comparing formats on one
+  dataset (accuracy or PR-AUC, document growth, per-class curves, every
+  epoch's document with playable audio).
+- Four science benchmarks with their learned HTML rulebooks and designed
+  views: `gravityspy`, `galaxy10`, `bloodmnist`, `eclipsing` (`sdm.science`,
+  the `science` extra, `reproduce/ai4science`).
+- The offline test suite is tracked and run by CI.
+
+### Changed
+- **Algorithms are `sdm` and `base`** (formerly `gate` and `baseline`).
+- **The gate accepts ties.** A candidate is kept unless it lowers protected
+  accuracy; the strict-gain rule and the 5% compression exception are gone.
+  On PODS this raised the markdown rulebook from 91.7 to 95.4 PR-AUC.
+- **`cycles` are `epochs`** everywhere: options, state, candidate log, raw
+  folders. Runs saved under the old name do not resume.
+- `format.md` is the single source of the default formats
+  (`DEFAULT_FORMAT_MD` reads it). Size caps: `html` 12,000 words / 60,000
+  characters, `image` 40,000 characters.
+- Rendered formats ask the writer for ASCII text (cairosvg has no glyph for
+  arrows and draws a box).
+- README rewritten as the package's reference documentation.
+
+### Removed
+- The in-context (`icl`) control, the GEPA and SkillOpt baselines, the
+  fine-tuning export, the graded free-response mode, and the ungated
+  `accept_all` switch.
+- Every dataset loader and experiment except `cifar10`, `pods`, `df2`, and
+  `camelyon17` (GSM8K, MBPP, LiveMath, IFBench, tabular, Omniglot, Dogs, the
+  other WILDS subsets, and more).
+- The `video` format: on PODS, 70 objects in 12 frames reached 18.5 PR-AUC
+  against 64.5 for one wordless picture.
+- The `--val` protected-validation option of the Camelyon17 command
+  (`holdout_split` remains in the Python API).
+
+## [0.1.0.dev0] - 2026-08-29
+
+First upload: the gate, the `markdown`, `html`, `image`, `audio`, and
+`video` formats, CIFAR-10, and the experiment template.

sdm_learn-0.1.0/FAQ.md

@@ -0,0 +1,24 @@
+# Frequently Asked Questions
+
+## Where do I configure the LLM?
+
+Copy `settings.example.json` to `settings.json`, then set `provider`, `model`,
+and `api_key` there. `settings.json` is gitignored.
+
+## Which LLM APIs are supported?
+
+See the **VIEW SUPPORTED APIs** table in the
+[README](README.md#configure-an-llm-api). OpenAI-compatible providers can also
+be configured with `"provider": "custom"` and a `gateway_url`.
+
+## Where should I put my experiment?
+
+Copy `runs/my_experiment.py`, update its `load_data()` function, and run the
+copy from the repository root. The shipped benchmarks need no copy:
+`sdm run --dataset cifar10|pods|df2|camelyon17`. Files created under `runs/` are gitignored except for
+the template.
+
+## Why use a virtual environment?
+
+It keeps this project's dependencies isolated and ensures the package is
+installed with the Python interpreter you intend to use.

sdm_learn-0.1.0/LICENSE

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

sdm_learn-0.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include README.md
+include FAQ.md
+include CHANGELOG.md
+include settings.example.json
+
+# The GIFs stay out of the distribution: 2.5 MB of animation helps a reader on
+# GitHub and does nothing for an install. The README reaches them by relative
+# path, which GitHub resolves and PyPI does not, so the PyPI page shows a
+# broken image until that link is made absolute at release time.
+prune assets
+prune runs