Skip to content

Added TOC #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EdAbati merged 4 commits into from
Oct 28, 2024
Merged

Added TOC #21

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7dbf44
added contents
EdAbati Oct 28, 2024
131956a
Remove contents section from README.md
EdAbati Oct 28, 2024
67cd244
update section headings for pandas and polars converters
EdAbati Oct 28, 2024
3635558
added contributing
EdAbati Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@

-----

- [📃 Description](#description)
- [🛠️ Installation](#installation)
- [💻 Usage](#usage)
- [DataFrameFileToDocument](#dataframefiletodocument)
- [`pandas` Converters](#pandas-converters)
- [FileToPandasDataFrame](#filetopandasdataframe)
- [PandasDataFrameConverter](#pandasdataframeconverter)
- [`polars` Converters](#polars-converters)
- [FileToPolarsDataFrame](#filetopolarsdataframe)
- [PolarsDataFrameConverter](#polarsdataframeconverter)
- [🤝 Contributing](#contributing)

-----

## 📃 Description

`dataframes-haystack` is an extension for [Haystack 2](https://docs.haystack.deepset.ai/docs/intro) that enables integration with dataframe libraries.
Expand Down Expand Up @@ -45,7 +59,7 @@ pip install "dataframes-haystack[polars]"
> [!TIP]
> See the [Example Notebooks](./notebooks) for complete examples.

## DataFrameFileToDocument
### DataFrameFileToDocument

[Complete example](https://github.com/EdAbati/dataframes-haystack/blob/main/notebooks/dataframe-file-to-doc-example.ipynb)

Expand All @@ -66,7 +80,7 @@ documents = converter.run(files=["file1.csv", "file2.csv"])
]}
```

### Pandas
### `pandas` Converters

[Complete example](https://github.com/EdAbati/dataframes-haystack/blob/main/notebooks/pandas-example.ipynb)

Expand Down Expand Up @@ -113,7 +127,7 @@ Result:
]}
```

### Polars
### `polars` Converters

[Complete example](https://github.com/EdAbati/dataframes-haystack/blob/main/notebooks/polars-example.ipynb)

Expand Down