# `tabben`: A Benchmark for Tabular Data

This is the documentation for the tabben benchmark for tabular data, its datasets, and python API (`tabben` python package).

```{toctree}
:maxdepth: 2
:caption: Benchmark
:hidden:

datasets/index
```

```{toctree}
:maxdepth: 2
:caption: Python Docs
:hidden:

python/tutorials/index
python/integrations/index
python/api/index
```

## Getting Started

To install the package, you can use your favorite python package manager (we recommend Python 3.8). Using `pip` for example,
```shell
pip install tabben
```

Then you're off to the races! Check out [how to use the package](./python/tutorials/index.md), [walk-throughs with different machine learning frameworks](./python/integrations/index.md), or [details about the datasets](./datasets/index.md).

```{admonition} Interoperability with other packages
:class: note

Depending on what you want to use `tabben` with, you may need to install other packages to interoperate, e.g. `scikit-learn`, PyTorch, `autogluon`.
```

## Citing

If you find this benchmark useful or use it in your research, please consider citing:

```bibtex

```