Skip to content

automl/tabpfn-client

Repository files navigation

TabPFN Client

PyPI version Discord colab Documentation

TabPFN is a foundation model for tabular data that outperforms traditional methods while being dramatically faster. This client library provides easy access to the TabPFN API, enabling state-of-the-art tabular machine learning in just a few lines of code.

⚠️ Alpha Release Note

This is an alpha release. While we've tested it thoroughly in our use cases, you may encounter occasional issues. We appreciate your understanding and feedback as we continue to improve the service.

This is a cloud-based service. Your data will be sent to our servers for processing.

Do NOT upload any Personally Identifiable Information (PII)

Do NOT upload any sensitive or confidential data

Do NOT upload any data you don't have permission to share

Consider anonymizing or pseudonymizing your data before upload

Review your organization's data sharing policies before use

🏁 Quick Start

Installation

pip install tabpfn-client

Basic Usage

from tabpfn_client import init, TabPFNClassifier

# Login (interactive first time)
init()

# Use it like any sklearn model
model = TabPFNClassifier()
model.fit(X_train, y_train)

# Get predictions
predictions = model.predict(X_test)

# Get probability estimates
probabilities = model.predict_proba(X_test)

📚 For detailed usage examples and best practices, check out:

🔑 Authentication

You can retrieve your access token

Save Your Token

import tabpfn_client
token = tabpfn_client.get_access_token()

and login (on another machine) using your access token, skipping the interactive flow, use:

tabpfn_client.set_access_token(token)

🤝 Join Our Community

We're building the future of tabular machine learning and would love your involvement! Here's how you can participate and get help:

  1. Try TabPFN: Use it in your projects and share your experience
  2. Connect & Learn:
  3. Contribute:
    • Report bugs or request features through issues
    • Submit pull requests (see development guide below)
    • Share your success stories and use cases
  4. Stay Updated: Star the repo and join Discord for the latest updates

Development

To encourage better coding practices, ruff has been added to the pre-commit hooks. This will ensure that the code is formatted properly before being committed. To enable pre-commit (if you haven't), run the following command:

pre-commit install

Additionally, it is recommended that developers install the ruff extension in their preferred editor. For installation instructions, refer to the Ruff Integrations Documentation.

Build for PyPI

if [ -d "dist" ]; then rm -rf dist/*; fi
python3 -m pip install --upgrade build; python3 -m build
python3 -m twine upload --repository pypi dist/*

Access/Delete Personal Information

You can use our UserDataClient to access and delete personal information.

from tabpfn_client import UserDataClient

print(UserDataClient.get_data_summary())

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages