synthefy-tabular 0.2.1__tar.gz

synthefy_tabular-0.2.1/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 2025 StableAI
+
+   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.

synthefy_tabular-0.2.1/NOTICE

@@ -0,0 +1,5 @@
+Synthefy Tabular
+Copyright 2026 Synthefy
+
+This product includes software developed by Synthefy and is licensed under
+the Apache License, Version 2.0.

synthefy_tabular-0.2.1/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: synthefy-tabular
+Version: 0.2.1
+Summary: Synthefy Tabular foundation model training, inference, and evaluation
+Author: Synthefy
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Synthefy/synthefy-tabular
+Project-URL: Repository, https://github.com/Synthefy/synthefy-tabular
+Project-URL: Issues, https://github.com/Synthefy/synthefy-tabular/issues
+Project-URL: Changelog, https://github.com/Synthefy/synthefy-tabular/releases
+Keywords: tabular,foundation-model,machine-learning,deep-learning,regression,pytorch,synthetic-data
+Classifier: Development Status :: 3 - 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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: einops>=0.7
+Requires-Dist: huggingface-hub>=1.0
+Requires-Dist: kditransform>=1.0
+Requires-Dist: numpy>=2.0
+Requires-Dist: pandas>=2.0
+Requires-Dist: scikit-learn>=1.4
+Requires-Dist: scipy>=1.13
+Requires-Dist: torch>=2.0
+Requires-Dist: tqdm>=4.65
+Requires-Dist: typing-extensions>=4.10
+Provides-Extra: train
+Requires-Dist: wandb>=0.15.0; extra == "train"
+Requires-Dist: xgboost; extra == "train"
+Provides-Extra: eval
+Requires-Dist: matplotlib; extra == "eval"
+Requires-Dist: openml; extra == "eval"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# Synthefy Tabular
+
+Synthefy Tabular is a tabular foundation model for **regression**
+via in-context learning (ICL). Given a few labeled rows as context, it predicts on
+new query rows in a single forward pass, with no task-specific training or fine-tuning.
+The model is trained entirely on synthetic data.
+
+This repository contains the public training, inference, evaluation, and Hugging
+Face checkpoint tooling.
+
+## Results
+
+Mean R² across 96 regression tasks from three public benchmark suites:
+
+| Source | Tasks | Mean R² |
+|--------|------:|--------:|
+| OpenML Regression | 11 | 0.6104 |
+| TabArena | 13 | 0.8089 |
+| TALENT | 72 | 0.7591 |
+
+Large-N / long-context tables (common in TabArena) are the current focus of the
+large-table training stages.
+
+> **Thinking** is an inference-time reasoning extension. Details are forthcoming.
+
+## How it works
+
+### Architecture
+
+Synthefy Tabular is a **FeaturesTransformer (~5.5M parameters)** that alternates
+two kinds of attention:
+
+- **Feature attention** learns relationships between columns.
+- **Sample attention** learns relationships between rows (context and query).
+- **In-context learning**: predictions condition on labeled context rows, with no
+  gradient updates at inference.
+
+Key config: 16 transformer layers, embed_dim 128, hidden 384, 2 heads, the
+**v2-lite** block (SwiGLU + RMSNorm + pre-norm), features grouped in pairs
+(`features_per_group=2`), with **column-specific y-aware** feature attention.
+Features are encoded with RBF embeddings; missing values are handled natively
+via learned mask embeddings.
+
+### Synthetic data
+
+The model never sees real data during training. Its capability comes from a diverse
+synthetic data generator covering real-world tabular regimes:
+
+- **Structural Causal Models (SCM)**: hierarchical DAGs with 8 edge-function types
+  (MLP, decision tree, piecewise-linear, polynomial, periodic, RBF, log/exp, conv1d).
+- **Regression priors**: 9 target families (dense/sparse linear, GAM, interactions,
+  random MLP, random tree, radial/RBF, Fourier features, chained trigonometric).
+- **Realism augmentations**: discretized features, noise features, correlated blocks,
+  structural missingness, label noise, class imbalance.
+- **Learnability filter**: an ExtraTrees signal-quality filter rejects unlearnable
+  datasets so training compute is spent on learnable tasks.
+
+See [docs/training.md](docs/training.md) for the full recipe.
+
+## Install
+
+```bash
+pip install synthefy-tabular
+```
+
+Optional extras:
+
+```bash
+pip install "synthefy-tabular[train]"   # training-only deps (wandb, xgboost)
+pip install "synthefy-tabular[eval]"    # evaluation-only deps (matplotlib, openml)
+```
+
+### Develop from source
+
+```bash
+git clone https://github.com/Synthefy/synthefy-tabular
+cd synthefy-tabular
+uv sync --extra dev
+```
+
+`uv sync` installs a pinned PyTorch build. If that CUDA build does not match your
+driver, install a PyTorch wheel matching your CUDA version instead. The Muon
+optimizer used in training prefers `torch.optim.Muon`; if your PyTorch lacks it,
+the package automatically falls back to a built-in implementation.
+
+## Authentication (optional)
+
+The default checkpoint at
+[`Synthefy/synthefy-tabular`](https://huggingface.co/Synthefy/synthefy-tabular)
+is **public**: the first inference call downloads and caches it automatically,
+with no token and no access request.
+
+A Hugging Face token is only worth setting if you hit anonymous download rate
+limits, or if you point the package at a private/gated checkpoint of your own.
+Provide one in any of these ways:
+
+```bash
+# Option A: env var (one-shot)
+export HF_TOKEN=hf_xxxxxxxx
+
+# Option B: persist via the HF CLI (huggingface-hub >= 1.0)
+hf auth login
+```
+
+```python
+# Option C: pass explicitly in code
+from synthefy_tabular import SynthefyTabularRegressor
+model = SynthefyTabularRegressor(token="hf_xxxxxxxx")
+```
+
+Get a token at <https://huggingface.co/settings/tokens> (read scope is
+sufficient). If you supply a local `model_path=` instead, no network access is
+needed at all.
+
+## Inference
+
+Pretrained weights are hosted on the Hugging Face Hub at
+[`Synthefy/synthefy-tabular`](https://huggingface.co/Synthefy/synthefy-tabular).
+The first call downloads and caches the checkpoint automatically, so a complete
+working example is just:
+
+```python
+from sklearn.datasets import load_diabetes
+from sklearn.model_selection import train_test_split
+from synthefy_tabular import SynthefyTabularRegressor
+
+X, y = load_diabetes(return_X_y=True)
+X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=0)
+
+model = SynthefyTabularRegressor()    # downloads weights from the HF Hub on first use
+model.fit(X_train, y_train)           # "fit" just stores the labeled rows as context
+pred = model.predict(X_test)          # predictions in a single forward pass, no training
+```
+
+It uses a GPU when one is available and falls back to CPU. A one-shot helper
+skips the object entirely:
+
+```python
+from synthefy_tabular import predict
+pred = predict(X_train, y_train, X_test, task="regression")
+```
+
+To run from your own checkpoint instead of the Hub default, pass a path:
+
+```python
+model = SynthefyTabularRegressor(model_path="path/to/checkpoint.pt")
+```
+
+`predict` follows the `TabPFNRegressor.predict` contract: pass
+`output_type="mean"` (default), `"median"`, or `"mode"` to choose the point
+estimate drawn from the model's predictive distribution.
+
+Runnable example: [`examples/inference_regression.py`](examples/inference_regression.py).
+More detail in [docs/inference.md](docs/inference.md).
+
+## Training
+
+Smoke test (2 steps, single GPU, no logging):
+
+```bash
+TOTAL_STEPS=2 NPROC_PER_NODE=1 WANDB_MODE=disabled bash scripts/train.sh
+```
+
+Training runs entirely on synthetic data and **trains to completion**: there is
+no real-data validation in the loop, so no benchmark data needs to
+be downloaded to train, and no eval signal influences checkpoint selection. Each
+run writes periodic and final checkpoints, and each curriculum tier seeds from
+the previous tier's final checkpoint.
+
+### Tier 1: from scratch
+
+```bash
+CUDA_VISIBLE_DEVICES=0,1,2,3 bash scripts/train.sh
+```
+
+Configurable via environment variables (`TOTAL_STEPS`, `LR`, `BATCH_SIZE`,
+`CUDA_VISIBLE_DEVICES`, ...; see the script header). Checkpoints land in
+`checkpoints/<run>/tier1/`.
+
+### Tiers 2 to 5: curriculum continuation
+
+One script runs the rest of the curriculum, each tier seeding from the previous
+tier's final checkpoint:
+
+```bash
+CUDA_VISIBLE_DEVICES=0,1,2,3 bash scripts/continue_training.sh
+```
+
+| Tier | Table shapes (N x F) | Focus |
+|---|---|---|
+| 2 | N ≤ 4K, F ≤ 384 | larger tables |
+| 3 | N ≤ 8K, F ≤ 768 | largest tables |
+| 4 | N ≤ 56K, F ≤ 96 | large-N / long-context specialist |
+| 5 | N ≤ 33K, F ≤ 1280 | both-large corner (N and F coupled by a cell budget) |
+
+It auto-detects the most recent tier-1 run, or point it at one with
+`RUN_ROOT=checkpoints/<run>`. Run a subset with `START_TIER` / `END_TIER`
+(e.g. `END_TIER=3` for tiers 2 to 3 only).
+
+> **Tiers 4 and 5 push N up to 56K rows.** Dense O(N²) sample attention at that
+> scale forces `batch=1` with large gradient accumulation, and can OOM or hang
+> depending on GPU memory. Smoke-probe them first; see the script header.
+
+Training uses the **Muon** optimizer (EMA 0.999), a **pinball** loss with 999
+quantiles + a monotonicity penalty, and bf16 mixed precision with DDP. Pass
+`--seed` for reproducible runs. Full options: [docs/training.md](docs/training.md).
+
+## Evaluation
+
+```bash
+synthefy-tabular-eval --checkpoint "Synthefy:path/to/checkpoint.pt"
+```
+
+or `bash scripts/evaluate.sh`. See [docs/evaluation.md](docs/evaluation.md) for
+benchmark sources and how to evaluate a Synthefy Tabular checkpoint.
+
+## Hugging Face
+
+```bash
+synthefy-tabular-download                                            # fetch default checkpoint
+synthefy-tabular-upload path/to/checkpoint.pt --repo-id Synthefy/synthefy-tabular
+```
+
+See [docs/huggingface.md](docs/huggingface.md).
+
+## Repository layout
+
+```
+src/synthefy_tabular/
+  api.py            Public API (SynthefyTabularRegressor, infer, predict)
+  model/            FeaturesTransformer architecture
+  training/         Data generation, trainer, loss, config, CLI
+  inference/        Sklearn-compatible predictor + preprocessing
+  evaluation/       Benchmark runner over public benchmark suites
+  hf.py             Hugging Face download / upload
+scripts/            train.sh, continue_training.sh, evaluate.sh
+docs/               training, inference, evaluation, huggingface guides
+examples/           Runnable inference / upload scripts
+```
+
+## License
+
+See [LICENSE](LICENSE) and [NOTICE](NOTICE).