Update README.md
Browse files
README.md
CHANGED
|
@@ -41,17 +41,21 @@ If you use this model in your research or want to refer to our work, please cite
|
|
| 41 |
|
| 42 |
## Requirements
|
| 43 |
|
| 44 |
-
This project uses model checkpoints available on
|
|
|
|
| 45 |
|
| 46 |
The requirements are detailed in the `pyproject.toml` file for Python 3.12 version.
|
| 47 |
|
| 48 |
-
Local installation in virtual environment:
|
| 49 |
```bash
|
| 50 |
-
git lfs pull
|
| 51 |
uv sync
|
| 52 |
source .venv/bin/activate
|
| 53 |
```
|
| 54 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
## Basic Usage
|
| 56 |
|
| 57 |
The model supports classification, regression, and matching tasks. It accepts input data in the form of a pandas DataFrame or a NumPy array. No preprocessing is required, column names and cell values are automatically embedded using an LLM, and any missing values are handled correctly.
|
|
|
|
| 41 |
|
| 42 |
## Requirements
|
| 43 |
|
| 44 |
+
This project uses model checkpoints available on https://huggingface.co/SAP/FlexTab that are automatically downloaded when running the model.
|
| 45 |
+
Note that downloading the model checkpoints requires logging in to Hugging Face. See the [instructions](https://huggingface.co/docs/huggingface_hub/quick-start#authentication) for details.
|
| 46 |
|
| 47 |
The requirements are detailed in the `pyproject.toml` file for Python 3.12 version.
|
| 48 |
|
| 49 |
+
Local installation in a virtual environment:
|
| 50 |
```bash
|
|
|
|
| 51 |
uv sync
|
| 52 |
source .venv/bin/activate
|
| 53 |
```
|
| 54 |
|
| 55 |
+
Installation from source:
|
| 56 |
+
```pip install git+https://github.com/SAP-samples/flextab```
|
| 57 |
+
|
| 58 |
+
|
| 59 |
## Basic Usage
|
| 60 |
|
| 61 |
The model supports classification, regression, and matching tasks. It accepts input data in the form of a pandas DataFrame or a NumPy array. No preprocessing is required, column names and cell values are automatically embedded using an LLM, and any missing values are handled correctly.
|