From d7dbf444bbde0532bf2996605f963141568aef3e Mon Sep 17 00:00:00 2001 From: Edoardo Abati <29585319+EdAbati@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:09:06 +0100 Subject: [PATCH 1/4] added contents --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7d19e5..f1d3125 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,21 @@ ----- +## Contents + +- [📃 Description](#description) +- [🛠️ Installation](#installation) +- [💻 Usage](#usage) + - [DataFrameFileToDocument](#dataframefiletodocument) + - [Pandas](#pandas) + - [FileToPandasDataFrame](#filetopandasdataframe) + - [PandasDataFrameConverter](#pandasdataframeconverter) + - [Polars](#polars) + - [FileToPolarsDataFrame](#filetopolarsdataframe) + - [PolarsDataFrameConverter](#polarsdataframeconverter) + +----- + ## 📃 Description `dataframes-haystack` is an extension for [Haystack 2](https://docs.haystack.deepset.ai/docs/intro) that enables integration with dataframe libraries. @@ -45,7 +60,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) From 131956a2d87d74dbe494f999d234fc884e8173fe Mon Sep 17 00:00:00 2001 From: Edoardo Abati <29585319+EdAbati@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:10:22 +0100 Subject: [PATCH 2/4] Remove contents section from README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f1d3125..0ee6a9f 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ ----- -## Contents - - [📃 Description](#description) - [🛠️ Installation](#installation) - [💻 Usage](#usage) From 67cd2442f6ec86d5bf1283560b99881d0e90ec15 Mon Sep 17 00:00:00 2001 From: Edoardo Abati <29585319+EdAbati@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:11:34 +0100 Subject: [PATCH 3/4] update section headings for pandas and polars converters --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ee6a9f..a6437b3 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ - [🛠️ Installation](#installation) - [💻 Usage](#usage) - [DataFrameFileToDocument](#dataframefiletodocument) - - [Pandas](#pandas) + - [`pandas` Converters](#pandas-converters) - [FileToPandasDataFrame](#filetopandasdataframe) - [PandasDataFrameConverter](#pandasdataframeconverter) - - [Polars](#polars) + - [`polars` Converters](#polars-converters) - [FileToPolarsDataFrame](#filetopolarsdataframe) - [PolarsDataFrameConverter](#polarsdataframeconverter) @@ -79,7 +79,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) @@ -126,7 +126,7 @@ Result: ]} ``` -### Polars +### `polars` Converters [Complete example](https://github.com/EdAbati/dataframes-haystack/blob/main/notebooks/polars-example.ipynb) From 363555826869084dd2735d0602ed880d3fa46ff3 Mon Sep 17 00:00:00 2001 From: Edoardo Abati <29585319+EdAbati@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:12:25 +0100 Subject: [PATCH 4/4] added contributing --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a6437b3..6d74f1f 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ - [`polars` Converters](#polars-converters) - [FileToPolarsDataFrame](#filetopolarsdataframe) - [PolarsDataFrameConverter](#polarsdataframeconverter) +- [🤝 Contributing](#contributing) -----