weihaokong commited on
Commit
e8c26e4
·
verified ·
1 Parent(s): d5f59ad

Add model card and license

Browse files
Files changed (2) hide show
  1. LICENSE +28 -0
  2. README.md +169 -0
LICENSE ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ TabFM Non-Commercial License v1.0
2
+
3
+ Google LLC ("we" or "our" or "Company") is pleased to make available the weights, parameters and inference code for the TabFM Model (as defined below) freely available for your non-commercial and non-production use as set forth in this TabFM Non-Commercial License ("License"). The "TabFM Model" means the TabFM AI models and models denoted as TabFM and their elements which includes algorithms, software, checkpoints, parameters, source code (inference code, evaluation code, and if applicable, fine-tuning code) and any other materials associated with the TabFM AI models made available by Company under this License, including, if any, the technical documentation, manuals and instructions for the use and operation thereof (collectively, "TabFM Model"). Note that we may also make available certain elements of what is included in the definition of "TabFM Model" under a separate license and nothing in this License will be deemed to restrict or limit any other licenses granted by us in such elements.
4
+
5
+ By downloading, accessing, using, Distributing (as defined below), or creating a Derivative (as defined below) of the TabFM Model, you agree to be bound by the terms of this License. If you do not agree to this License, then you do not have any rights to access, use or create a Derivative of the TabFM Model and you must immediately cease using the TabFM Model. If you are agreeing to be bound by the terms of this License on behalf of your employer or other entity, you represent and warrant to us that you have full legal authority to bind your employer or such entity to this License. If you do not have the requisite authority, you may not accept the License or access the TabFM Model on behalf of your employer or other entity.
6
+
7
+ This License applies only to individuals or entities who download the TabFM Model. For customers accessing the TabFM Model through our API, other terms and conditions may apply.
8
+ 1. Definitions
9
+ a. "Derivative" means any (i) modified version of the TabFM Model (including but not limited to any customized, fine-tuned, retrained, or otherwise adapted version thereof); (ii) work that incorporates, utilizes, or is otherwise based on or derived from the TabFM Model, its logic, or parameters; or (iii) any other derivative work thereof, in each case whether or not such work constitutes a derivative work under applicable copyright law. For the avoidance of doubt, Outputs are not considered Derivatives under this License.
10
+ b. "Distribution," "Distribute," or "Distributing" means providing or making available, by any means, a copy of the TabFM Model and/or the Derivatives as the case may be.
11
+ c. "Non-Commercial Purpose" means use for testing, evaluation, or research not tied to commercial gain, production deployment, or revenue generation. This includes internal benchmarking, academic research, and experimentation on private or public datasets, provided the results are not used in commercial decision-making, client deliverables, or paid products/services. For clarity, use (a) for any revenue-generating activity, (b) in direct or indirect interactions with end users or production systems, or (c) to train, fine-tune, or distill other models for commercial use, in each case is not a Non-Commercial Purpose.
12
+ d. "Outputs" means predictions, scores, probabilities, recommendations, explanations, or other results generated by operation of the TabFM Model or any Derivative from datasets or other inputs supplied by a user. For the avoidance of doubt, Outputs do not include any components of the TabFM Model, such as any fine-tuned versions of the TabFM Model, the weights, or parameters.
13
+ e. "you" or "your" means the individual or entity entering into this License with Company.
14
+ 2. License Grant
15
+ a. License. Subject to your compliance with this License, Company grants you a non-exclusive, worldwide, non-transferable, non-sublicensable, revocable, royalty-free and limited license to access, use and create Derivatives of the TabFM Model solely for your Non-Commercial Purposes. The foregoing license is personal to you, and you may not assign or sublicense this License or any other rights or obligations under this License without Company's prior written consent; any such assignment or sublicense will be void and will automatically and immediately terminate this License. Any restrictions set forth herein regarding the TabFM Model also apply to any Derivative you create or that are created on your behalf.
16
+ b. Non-Commercial Use Only. You may only access, use, or create Derivatives of the TabFM Model for Non-Commercial Purposes. If you want to use the TabFM Model or a Derivative for any purpose that is not expressly authorized under this License, such as for a commercial or production activity, you must obtain a commercial license from Company, which Company may grant in its sole discretion and which additional use may be subject to a fee, royalty or other revenue share.
17
+ c. Reserved Rights. The grant of rights expressly set forth in this License are the complete grant of rights to you in the TabFM Model, and no other licenses are granted, whether by waiver, estoppel, implication, equity or otherwise. Company and its licensors reserve all rights not expressly granted by this License.
18
+ d. Compliance and Safeguards. You must ensure that any use of the TabFM Model, Derivatives, and Outputs complies with applicable data protection, privacy, export control, and AI regulations (including, where applicable, GDPR and the EU Artificial Intelligence Act), and that you implement reasonable technical and organizational measures appropriate to the data and risks involved.
19
+ 3. Restrictions
20
+ You will not, and will not permit, assist or cause any third party to:
21
+ a. use, modify, copy, reproduce, create Derivatives of, or Distribute the TabFM Model (or any Derivative thereof, or any Outputs and data produced by the TabFM Model), in whole or in part for any commercial or production purposes; or
22
+ b. Distribute the TabFM Model or a Derivative.
23
+ 4. Disclaimer of Warranties
24
+ THE TABFM MODEL IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT WILL COMPANY BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE TABFM MODEL OR THE USE OR OTHER DEALINGS IN THE TABFM MODEL.
25
+ 5. Limitation of Liability
26
+ TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL COMPANY BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE TABFM MODEL, EVEN IF YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
27
+ 6. Trademarks
28
+ You have not been granted any trademark license as part of this License and may not use any name, logo or trademark associated with Company without the prior written permission of Company.
README.md ADDED
@@ -0,0 +1,169 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: tabfm-non-commercial-v1.0
4
+ license_link: https://huggingface.co/google/tabfm-1.1.0-pytorch/blob/main/LICENSE
5
+ library_name: tabfm
6
+ pipeline_tag: tabular-classification
7
+ tags:
8
+ - tabular
9
+ - tabular-regression
10
+ - zero-shot
11
+ - in-context-learning
12
+ - pytorch
13
+ - foundation-model
14
+ ---
15
+
16
+ # TabFM 1.1.0 (PyTorch)
17
+
18
+ TabFM is a zero-shot tabular foundation model from Google Research. It supports
19
+ classification and regression on structured/tabular data with mixed numerical and
20
+ categorical columns, requiring no fine-tuning or hyperparameter search - training
21
+ examples are passed as context and predictions are made in a single forward pass.
22
+
23
+ This repository contains the **PyTorch** weights. For the JAX/Flax weights see
24
+ [google/tabfm-1.1.0-jax](https://huggingface.co/google/tabfm-1.1.0-jax).
25
+
26
+ ## Getting Started
27
+
28
+ ```bash
29
+ pip install tabfm[pytorch]
30
+ ```
31
+
32
+ **Classification:**
33
+
34
+ ```python
35
+ from tabfm import TabFMClassifier, tabfm_v1_1_0_pytorch as tabfm_v1_1_0
36
+
37
+ model = tabfm_v1_1_0.load(model_type="classification")
38
+ clf = TabFMClassifier(model=model)
39
+ clf.fit(X_train, y_train)
40
+ probs = clf.predict_proba(X_test)
41
+ ```
42
+
43
+ **Regression:**
44
+
45
+ ```python
46
+ from tabfm import TabFMRegressor, tabfm_v1_1_0_pytorch as tabfm_v1_1_0
47
+
48
+ model = tabfm_v1_1_0.load(model_type="regression")
49
+ reg = TabFMRegressor(model=model)
50
+ reg.fit(X_train, y_train)
51
+ preds = reg.predict(X_test)
52
+ ```
53
+
54
+ You can also load directly using the HuggingFace Hub API:
55
+
56
+ ```python
57
+ from tabfm.src.pytorch.tabfm_v1_1_0 import TabFM_HF
58
+
59
+ clf_model = TabFM_HF.from_pretrained("google/tabfm-1.1.0-pytorch", subfolder="classification")
60
+ reg_model = TabFM_HF.from_pretrained("google/tabfm-1.1.0-pytorch", subfolder="regression")
61
+ ```
62
+
63
+ ### Available Checkpoints
64
+
65
+ | Subfolder | Task | `is_classifier` |
66
+ |-----------|------|-----------------|
67
+ | `classification/` | Classification (up to 10 classes) | `True` |
68
+ | `regression/` | Regression | `False` |
69
+
70
+ ## Developers and Affiliations
71
+
72
+ Developed by the [Google Research](https://research.google) team.
73
+
74
+ ## Intended Use
75
+
76
+ - Tabular data with numerical and/or categorical columns
77
+ - Binary and multiclass classification (up to 10 classes)
78
+ - Regression on continuous targets
79
+ - Zero-shot inference: no dataset-specific training or hyperparameter tuning
80
+ - Works with DataFrames (pandas) or numpy arrays
81
+
82
+ ## Not Intended For
83
+
84
+ - Images, audio, video, or raw text
85
+ - More than 10 output classes (hard model limit)
86
+ - Tasks requiring task-specific fine-tuning
87
+ - Non-tabular structured data (graphs, sequences)
88
+ - Commercial use (see License below)
89
+
90
+ ## Model Architecture
91
+
92
+ TabFM uses alternating row and column attention to capture both feature interactions
93
+ and row-level patterns:
94
+
95
+ 1. **Column attention** (Set Transformer): embeds each cell using Fourier features and
96
+ a per-group linear projection, then aggregates across rows via induced self-attention
97
+ 2. **Row compression**: CLS tokens summarise each row into a dense vector via row-level
98
+ attention with Rotary Position Embedding (RoPE)
99
+ 3. **ICL Transformer**: a 24-block causal transformer operates over the compressed row
100
+ vectors, treating training rows as context and outputting predictions for test rows
101
+
102
+ Key hyperparameters:
103
+
104
+ | Parameter | Value |
105
+ |-----------|-------|
106
+ | Embedding dim | 256 |
107
+ | Column attention blocks | 3 (4 heads, 256 induced points) |
108
+ | Row attention blocks | 3 (8 heads, 8 CLS tokens) |
109
+ | ICL transformer blocks | 24 (8 heads) |
110
+ | Feed-forward factor | 4 |
111
+ | Max classes | 10 |
112
+ | Activation | SwiGLU |
113
+ | Fourier features | 32 frequencies |
114
+
115
+ ## Training Data and Priors
116
+
117
+ TabFM was trained on hundreds of millions of **synthetic** datasets generated
118
+ dynamically using structural causal models (SCMs). Synthetic data was chosen due to
119
+ the scarcity of diverse, high-quality open-source tabular datasets and to avoid
120
+ privacy/licensing concerns with real-world industrial data. The SCM prior encodes
121
+ inductive biases about causal structure and feature relationships typical in tabular
122
+ tasks.
123
+
124
+ ## Performance
125
+
126
+ TabFM was evaluated on [TabArena](https://tabarena.ai) across 51 datasets
127
+ (38 classification, 13 regression). In zero-shot mode - a single forward pass with no
128
+ hyperparameter search - TabFM outperforms heavily-tuned supervised baselines including
129
+ gradient-boosted trees. The `TabFMClassifier.ensemble()` preset (feature crosses,
130
+ SVD features, NNLS blending) yields further improvements.
131
+
132
+ See the [Google Research blog post](https://research.google/blog/introducing-tabfm-a-zero-shot-foundation-model-for-tabular-data/) for full benchmark details.
133
+
134
+ ## Ethical Considerations
135
+
136
+ TabFM was trained entirely on synthetic data. Performance on specific real-world
137
+ domains, minority groups, or edge distributions is not fully characterised. Users
138
+ should evaluate the model on held-out data representative of their use case before
139
+ deploying in high-stakes settings.
140
+
141
+ ## Limitations
142
+
143
+ - **Max 10 classes** for classification (hard architectural limit)
144
+ - Memory usage scales with the number of training rows (all rows are passed as context)
145
+ - Optimised for tables up to 500 features; behaviour on very wide tables may degrade
146
+ - Performance is not guaranteed to match task-specific, fine-tuned models on all datasets
147
+ - Not an officially supported Google product
148
+
149
+ ## License
150
+
151
+ The model weights in this repository are released under the
152
+ **TabFM Non-Commercial License v1.0** - see [LICENSE](https://huggingface.co/google/tabfm-1.1.0-pytorch/blob/main/LICENSE). The source code is
153
+ Apache 2.0 licensed via [google-research/tabfm](https://github.com/google-research/tabfm).
154
+
155
+ ## Version
156
+
157
+ 1.1.0
158
+
159
+ ## Citation
160
+
161
+ ```bibtex
162
+ @article{tabfm2026,
163
+ title = {TabFM: A Zero-Shot Foundation Model for Tabular Data},
164
+ author = {Google Research},
165
+ year = {2026},
166
+ url = {https://research.google/blog/introducing-tabfm-a-zero-shot-foundation-model-for-tabular-data/}
167
+ }
168
+ ```
169
+