diff --git a/docs/classification.md b/docs/classification.md new file mode 100644 index 0000000..6f15bc2 --- /dev/null +++ b/docs/classification.md @@ -0,0 +1,28 @@ +# Classification + +TabPFN provides a powerful interface for handling classification tasks on tabular data. The `TabPFNClassifier` class can be used for binary and multi-class classification problems. + +## Example + +Below is an example of how to use `TabPFNClassifier` for a multi-class classification task: + +```python +from tabpfn import TabPFNClassifier +from sklearn.datasets import load_iris +from sklearn.model_selection import train_test_split +from sklearn.metrics import accuracy_score + +# Load the Iris dataset +X, y = load_iris(return_X_y=True) + +# Split data +X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42) + +# Initialize and train classifier +classifier = TabPFNClassifier(device='cuda', N_ensemble_configurations=10) +classifier.fit(X_train, y_train) + +# Evaluate +y_pred = classifier.predict(X_test) +print('Test Accuracy:', accuracy_score(y_test, y_pred)) +``` \ No newline at end of file diff --git a/docs/configuration.md b/docs/configuration.md deleted file mode 100644 index e3d3910..0000000 --- a/docs/configuration.md +++ /dev/null @@ -1,52 +0,0 @@ -# Configuration - -## Configuration - part 1 - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Configuration - part 2 - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Configuration - part 3 - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/deployment.md b/docs/deployment.md deleted file mode 100644 index 8c4055c..0000000 --- a/docs/deployment.md +++ /dev/null @@ -1,52 +0,0 @@ -# Deployment - -## Sorte dilapsa veniam roganti undas tum ab - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Amictus polenta carina admirantibus faciat - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Sum ait Othrysque hoc unum convexa hinc - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/development.md b/docs/development.md deleted file mode 100644 index 77c63b3..0000000 --- a/docs/development.md +++ /dev/null @@ -1,72 +0,0 @@ -# Development - -## Local environment - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Using containers - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Version control - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. - - -## Troubleshooting - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/example.md b/docs/example.md deleted file mode 100644 index f712879..0000000 --- a/docs/example.md +++ /dev/null @@ -1,52 +0,0 @@ -# Example - -## Legacy applications - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Modern applications - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Hybrid applications - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 0000000..a9f76bf --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,40 @@ +# Installation + +To install TabPFN, you can simply use pip. The basic installation is suitable for most users who are interested in applying TabPFN models to their tabular data. + +```bash +pip install tabpfn +For users interested in a more comprehensive setup, including the ability to train models, evaluate them as done in our paper, and use baselines, the full installation is recommended: +``` + +```bash +pip install tabpfn[full] +``` +Note: To use AutoGluon and Auto-sklearn baselines, please create separate environments and install autosklearn==0.14.5 and autogluon==0.4.0 respectively. Installing them in the same environment as TabPFN may not be possible due to dependency conflicts. + +## Example + +A simple way to get started with TabPFN using our sklearn interface is demonstrated below. This example shows how to train a classifier on the breast cancer dataset and evaluate its accuracy. + +```python +from sklearn.metrics import accuracy_score +from sklearn.datasets import load_breast_cancer +from sklearn.model_selection import train_test_split + +from tabpfn import TabPFNClassifier + +# Load data +X, y = load_breast_cancer(return_X_y=True) +X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.33, random_state=42) + +# Initialize classifier +classifier = TabPFNClassifier(device='cpu', N_ensemble_configurations=32) + +# Train classifier +classifier.fit(X_train, y_train) + +# Predict and evaluate +y_pred = classifier.predict(X_test) +print('Accuracy:', accuracy_score(y_test, y_pred)) +``` +This example demonstrates the basic workflow of training and predicting with TabPFN models. For more advanced usage, including handling of categorical data, please refer to the Advanced Usage section. diff --git a/docs/index.md b/docs/index.md index fcef7ac..e7d8f21 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,73 +1,23 @@ -# Welcome to Sample Project Official Documentation +# Welcome to TabPFN Documentation -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +TabPFN is a cutting-edge neural network designed specifically for tabular data prediction, leveraging the power of transformers to provide state-of-the-art performance on a wide range of datasets. This documentation will guide you through the installation, basic usage, and advanced features of TabPFN, helping you to efficiently integrate this powerful tool into your data science workflow. -## Commands +## Features -- `mkdocs new [dir-name]` - Create a new project. -- `mkdocs serve` - Start the live-reloading docs server. -- `mkdocs build` - Build the documentation site. -- `mkdocs -h` - Print help message and exit. +- **High Performance**: TabPFN brings the power of transformers to tabular data, achieving top-tier results across various datasets. +- **Easy Integration**: Designed with an sklearn-like interface, TabPFN can be seamlessly integrated into existing workflows. +- **Versatility**: Whether you're working on classification, regression, or even survival analysis tasks, TabPFN has you covered. +- **Efficiency**: Optimized for both CPU and GPU, TabPFN ensures fast training and inference times, making it suitable for projects of any scale. -!!! info - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod -nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor -massa, nec semper lorem quam in massa. +## Quick Links -## Bash +- [Installation](docs/installation.md): Get started by installing TabPFN in your environment. +- [Getting Started](docs/getting_started.md): Learn how to quickly train and evaluate your first TabPFN model. +- [Classification](docs/classification.md): Dive into using TabPFN for classification tasks, with examples and tips. +- [Regression](docs/regression.md): Explore how to apply TabPFN to regression problems, including setup and evaluation. -```bash -# Minimal makefile for Sphinx documentation -# +## Getting Help -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build +If you encounter any issues or have questions about using TabPFN, please refer to the [FAQs](#) or reach out to the community through [GitHub Issues](https://github.com/your-github-repo/issues). -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - - -``` - -## Syntax highlighting Example - -```python -import flask -import flask_saml - -app = flask.Flask(__name__) - -app.config.update({ - 'SECRET_KEY': 'soverysecret', - 'SAML_METADATA_URL': 'https://mymetadata.xml', -}) -flask_saml.FlaskSAML(app) -``` - -## Sample layout - -```bash -├── docs -│   ├── about.md -│   └── index.md -├── mkdocs.yml -└── site - ├── 404.html - ├── about - │   └── search_index.json - ├── sitemap.xml - └── sitemap.xml.gz - -``` +Thank you for choosing TabPFN. We hope you find this tool valuable in your data science endeavors. diff --git a/docs/install.md b/docs/install.md index d0e90ca..e69de29 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,59 +0,0 @@ -# Install - - -!!! info - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod - nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor - massa, nec semper lorem quam in massa. - - -## Install - step 1 - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Install - step 2 - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Install - step 3 - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/introduction.md b/docs/introduction.md deleted file mode 100644 index 8f21c49..0000000 --- a/docs/introduction.md +++ /dev/null @@ -1,52 +0,0 @@ -# Introduction - -## History - -Lorem markdownum. Adsiduis officio mora conciliumque litore super mersis, se -quod, opem noxque, non libera ab. Infra opus peregit non. Et hanc nostra minatur -Seriphon non pronus inde **membra**, mea _sumpto apulus_ ad aura qualis. Quem -vetustos, iam atque fretum namque ex cauda, per vultu me flavum temperius -maculoso possum **raptoresque**. - -**Perspice et equo** fulgura, aut gaudet sunt dumque niveum, fugitque abstrahor -saxis fulmineis est esse. Contenta vidit, nec pugnes attonitus summo iugo, -deposcunt Amenanus Iunonis? Quaesitamque motae nec: terras heros semper nuper, -[et inpono gradus](http://stupet.com/propiusquepartem.php), ab. - -## Distributions - -Tum quae convicia studiis: faxo cunas visa clarus, quondam, prius. Novi nata -dedit, Poemenis trementi haruspex prodere fontem: e. Nova nubes bracchia aras -squamas moraque _ad segetes_ remoto. - -```bash -> Modo dira nostroque congreditur patria si corpus insidior illam lusibus per -> vim relinquunt talia. Per an supremo gaudet latices *Melaneus* latuerunt tibi -> petebar, Pirithoi spectacula. Et hectora limina, quaeque, hoc adde precor -> domosque, sed in dieque, me pinnis desunt, cadunt. Nam fallacis isto talia -> tenues inferiusque non solito hic matre? Mirum at licet qui cuncta collo -> [deductus](http://www.fraude-ignipedum.io/) animoque quoque. -``` - -Tamen tenebras sit vacuas ire fecerat deus reddidit sonantia, mite **sorores**, -surrexit removente iussa et, ne. Verba malorum Lycias tempestiva irae ex mentes -illo durasse Proteus genitore habes; Phoebes doloris, **et rara**. - -## Licensing - -Inque inmurmurat at prodere: o viri corpora nuper, ut calido certa **cum**. -Ilios enim iam iniustaque fonti, ab torva. Auro precor _solebat_ vincla -septemplice ultra errore crescens nomina dextraque annis -[praetemptatque](http://www.imaginenostris.org/) carpitque protinus dextra, -exanimem, fatentis. Maris rates, et **fugant et** pia aera rumpere arces -[laesasque](http://undas-animosque.io/pocula), ira silvas quem ministri variatis -Cerberon videntem si. - -> Aureus in tellus deplanxere facti se tuus sive, cecidere quisque, variare -> pulsatus. Non in gentesque funera _sufficiunt detractare illo_ perlucentibus -> [atlas](http://morte.io/pabulaaltismunera) vel reperta non insula. - -Noctis tamen. Ora facta armo montis iussae Busirin in flammae inanes. - -Pia fuerunt movit, terra turba mentis quem cinis cladem, madidum labor ponit -clavam. Imo vitamque: diem cum ore intravit pro filia Aiax. diff --git a/docs/regression.md b/docs/regression.md new file mode 100644 index 0000000..e390128 --- /dev/null +++ b/docs/regression.md @@ -0,0 +1,29 @@ +# Regression + +TabPFN can also be applied to regression tasks using the `TabPFNRegressor` class. This allows for predictive modeling of continuous outcomes. + +## Example + +An example usage of `TabPFNRegressor` is shown below: + +```python +from tabpfn import TabPFNRegressor +from sklearn.datasets import load_boston +from sklearn.model_selection import train_test_split +from sklearn.metrics import mean_squared_error + +# Load Boston housing dataset +X, y = load_boston(return_X_y=True) + +# Split data +X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42) + +# Initialize and train regressor +regressor = TabPFNRegressor(device='cuda', N_ensemble_configurations=10) +regressor.fit(X_train, y_train) + +# Predict and evaluate +y_pred = regressor.predict(X_test) +print('Test RMSE:', mean_squared_error(y_test, y_pred, squared=False)) +``` +This example demonstrates how to train and evaluate a regression model. For more details on TabPFNRegressor and its parameters, refer to the API Reference section. \ No newline at end of file diff --git a/docs/release_notes.md b/docs/release_notes.md index a3594a3..d8ed92c 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -7,149 +7,5 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] - ## [1.0.0] - 2017-06-20 -### Added -- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). -- Version navigation. -- Links to latest released version in previous versions. -- "Why keep a changelog?" section. -- "Who needs a changelog?" section. -- "How do I make a changelog?" section. -- "Frequently Asked Questions" section. -- New "Guiding Principles" sub-section to "How do I make a changelog?". -- Simplified and Traditional Chinese translations from [@tianshuo](https://github.com/tianshuo). -- German translation from [@mpbzh](https://github.com/mpbzh) & [@Art4](https://github.com/Art4). -- Italian translation from [@azkidenz](https://github.com/azkidenz). -- Swedish translation from [@magol](https://github.com/magol). -- Turkish translation from [@karalamalar](https://github.com/karalamalar). -- French translation from [@zapashcanon](https://github.com/zapashcanon). -- Brazilian Portugese translation from [@Webysther](https://github.com/Webysther). -- Polish translation from [@amielucha](https://github.com/amielucha) & [@m-aciek](https://github.com/m-aciek). -- Russian translation from [@aishek](https://github.com/aishek). -- Czech translation from [@h4vry](https://github.com/h4vry). -- Slovak translation from [@jkostolansky](https://github.com/jkostolansky). -- Korean translation from [@pierceh89](https://github.com/pierceh89). -- Croatian translation from [@porx](https://github.com/porx). -- Persian translation from [@Hameds](https://github.com/Hameds). -- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s). - -### Changed -- Start using "changelog" over "change log" since it's the common usage. -- Start versioning based on the current English version at 0.3.0 to help -translation authors keep things up-to-date. -- Rewrite "What makes unicorns cry?" section. -- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal - scenario. -- Improve "Commit log diffs" sub-section to further argument against - them. -- Merge "Why can’t people just use a git log diff?" with "Commit log - diffs" -- Fix typos in Simplified Chinese and Traditional Chinese translations. -- Fix typos in Brazilian Portuguese translation. -- Fix typos in Turkish translation. -- Fix typos in Czech translation. -- Fix typos in Swedish translation. -- Improve phrasing in French translation. -- Fix phrasing and spelling in German translation. - -### Removed -- Section about "changelog" vs "CHANGELOG". - -## [0.3.0] - 2015-12-03 -### Added -- RU translation from [@aishek](https://github.com/aishek). -- pt-BR translation from [@tallesl](https://github.com/tallesl). -- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex). - -## [0.2.0] - 2015-10-06 -### Changed -- Remove exclusionary mentions of "open source" since this project can -benefit both "open" and "closed" source projects equally. - -## [0.1.0] - 2015-10-06 -### Added -- Answer "Should you ever rewrite a change log?". - -### Changed -- Improve argument against commit logs. -- Start following [SemVer](https://semver.org) properly. - -## [0.0.8] - 2015-02-17 -### Changed -- Update year to match in every README example. -- Reluctantly stop making fun of Brits only, since most of the world - writes dates in a strange way. - -### Fixed -- Fix typos in recent README changes. -- Update outdated unreleased diff link. - -## [0.0.7] - 2015-02-16 -### Added -- Link, and make it obvious that date format is ISO 8601. - -### Changed -- Clarified the section on "Is there a standard change log format?". - -### Fixed -- Fix Markdown links to tag comparison URL with footnote-style links. - -## [0.0.6] - 2014-12-12 -### Added -- README section on "yanked" releases. - -## [0.0.5] - 2014-08-09 -### Added -- Markdown links to version tags on release headings. -- Unreleased section to gather unreleased changes and encourage note -keeping prior to releases. - -## [0.0.4] - 2014-08-09 -### Added -- Better explanation of the difference between the file ("CHANGELOG") -and its function "the change log". - -### Changed -- Refer to a "change log" instead of a "CHANGELOG" throughout the site -to differentiate between the file and the purpose of the file — the -logging of changes. - -### Removed -- Remove empty sections from CHANGELOG, they occupy too much space and -create too much noise in the file. People will have to assume that the -missing sections were intentionally left out because they contained no -notable changes. - -## [0.0.3] - 2014-08-09 -### Added -- "Why should I care?" section mentioning The Changelog podcast. - -## [0.0.2] - 2014-07-10 -### Added -- Explanation of the recommended reverse chronological release ordering. - -## [0.0.1] - 2014-05-31 -### Added -- This CHANGELOG file to hopefully serve as an evolving example of a - standardized open source project CHANGELOG. -- CNAME file to enable GitHub Pages custom domain -- README now contains answers to common questions about CHANGELOGs -- Good examples and basic guidelines, including proper date formatting. -- Counter-examples: "What makes unicorns cry?" - -[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD -[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0 -[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0 -[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0 -[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0 -[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8 -[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7 -[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6 -[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5 -[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4 -[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3 -[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2 -[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1``` -```` +```` \ No newline at end of file