From 689472cc7123b489b820032f8b37dca5bcc85d32 Mon Sep 17 00:00:00 2001 From: noahho Date: Wed, 8 Jan 2025 12:01:30 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index fe95199..4713ccf 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ This is a cloud-based service. Your data will be sent to our servers for process - Consider anonymizing or pseudonymizing your data before upload - Review your organization's data sharing policies before use +## 🌐 TabPFN Ecosystem + +Choose the right TabPFN implementation for your needs: + +- **TabPFN Client (this repo)**: Easy-to-use API client for cloud-based inference +- **[TabPFN Extensions](https://github.com/priorlabs/tabpfn-extensions)**: Community extensions and integrations +- **[TabPFN](https://github.com/priorlabs/tabpfn)*: Core implementation for local deployment and research + ## 🏁 Quick Start ### Installation From 5aa2fb962b985827274c1e2c1aae373790b16f7c Mon Sep 17 00:00:00 2001 From: noahho Date: Wed, 8 Jan 2025 12:01:48 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4713ccf..19b35a9 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Choose the right TabPFN implementation for your needs: - **TabPFN Client (this repo)**: Easy-to-use API client for cloud-based inference - **[TabPFN Extensions](https://github.com/priorlabs/tabpfn-extensions)**: Community extensions and integrations -- **[TabPFN](https://github.com/priorlabs/tabpfn)*: Core implementation for local deployment and research +- **[TabPFN](https://github.com/priorlabs/tabpfn)**: Core implementation for local deployment and research ## 🏁 Quick Start From 4fa3c13d3fb4bd2751162e6d6213760e6654f372 Mon Sep 17 00:00:00 2001 From: noahho Date: Wed, 8 Jan 2025 13:56:41 +0100 Subject: [PATCH 3/4] - colab links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19b35a9..76f8615 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # TabPFN Client [![PyPI version](https://badge.fury.io/py/tabpfn-client.svg)](https://badge.fury.io/py/tabpfn-client) [![Discord](https://img.shields.io/discord/1285598202732482621?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.com/channels/1285598202732482621/) -[![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1ns_KdtyHgl29AOVwTw9c-DZrPj7fx_DW?usp=sharing) +[![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1SHa43VuHASLjevzO7y3-wPCxHY18-2H6?usp=sharing) [![Documentation](https://img.shields.io/badge/docs-priorlabs.ai-blue)](https://priorlabs.ai/) [![Twitter Follow](https://img.shields.io/twitter/follow/Prior_Labs?style=social)](https://twitter.com/Prior_Labs) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -11,7 +11,7 @@ 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. 📚 For detailed usage examples and best practices, check out: -- [Interactive Colab Tutorial](https://colab.research.google.com/drive/1ns_KdtyHgl29AOVwTw9c-DZrPj7fx_DW?usp=sharing) +- [Interactive Colab Tutorial](https://colab.research.google.com/drive/1SHa43VuHASLjevzO7y3-wPCxHY18-2H6?usp=sharing) ## ⚠️ 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. From 4337c2396148360be4aeb1f615fd4b14030e7e26 Mon Sep 17 00:00:00 2001 From: noahho Date: Wed, 8 Jan 2025 18:17:24 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76f8615..f6e7dd2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # TabPFN Client [![PyPI version](https://badge.fury.io/py/tabpfn-client.svg)](https://badge.fury.io/py/tabpfn-client) [![Discord](https://img.shields.io/discord/1285598202732482621?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.com/channels/1285598202732482621/) -[![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1SHa43VuHASLjevzO7y3-wPCxHY18-2H6?usp=sharing) +[![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://tinyurl.com/tabpfn-colab-online) [![Documentation](https://img.shields.io/badge/docs-priorlabs.ai-blue)](https://priorlabs.ai/) [![Twitter Follow](https://img.shields.io/twitter/follow/Prior_Labs?style=social)](https://twitter.com/Prior_Labs) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -10,8 +10,7 @@ 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. -📚 For detailed usage examples and best practices, check out: -- [Interactive Colab Tutorial](https://colab.research.google.com/drive/1SHa43VuHASLjevzO7y3-wPCxHY18-2H6?usp=sharing) +📚 For detailed usage examples and best practices, check out our [Interactive Colab Tutorial](https://tinyurl.com/tabpfn-colab-online) ## ⚠️ 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. @@ -131,6 +130,23 @@ from tabpfn_client import UserDataClient print(UserDataClient.get_data_summary()) ``` +## 📚 Citation + +```bibtex +@article{hollmann2024tabpfn, + title={Accurate predictions on small data with a tabular foundation model}, + author={Hollmann, Noah and M{\"u}ller, Samuel and Purucker, Lennart and + Krishnakumar, Arjun and K{\"o}rfer, Max and Hoo, Shi Bin and + Schirrmeister, Robin Tibor and Hutter, Frank}, + journal={Nature}, + year={2024}, + month={01}, + day={09}, + doi={10.1038/s41586-024-08328-6}, + publisher={Springer Nature}, + url={https://www.nature.com/articles/s41586-024-08328-6}, +} +``` ## 🤝 License