chunking-experiment 0.1.0

A package for experimenting with different data chunking strategies

Chunking Experiment

A Python package to chunk pandas/numpy data with different chunking strategies.

Requirements

• Python 3.10+
• Gradio
• pandas
• pytest
• numpy

Installation

pip install chunking-experiment

Or:

make install

Usage

from chunking_experiment import ChunkingExperiment

Create an instance of a Chunking class

class_instance = ChunkingExperiment(
"input.csv",
"output.csv",
n_chunks=3,
chunking_strategy="rows"
)

Then perform the chunking:

class_instance.process_chunks()

Run the web interface

Go to the app folder and run the following command:

from gradio_interface import launch_interface
launch_interface()

Alternatively, you can run the following command to start the web interface:

python gradio_interface.py

Features

• Multiple chunking strategies (rows, columns, tokens)
• Support for CSV, JSON, Numpy and Parquet files
• Web interface using Gradio
• Comprehensive test suite
• Documentation using Sphinx
• Benchmarking the chunking strategies

Development

To install development dependencies:

pip install -e .[dev]

Or:

make install-dev

Testing

To run tests, run the following command from the root folder:

pytest

Documentation

To install the documentation dependencies:

pip install -e .[docs]

Or:

make install-docs

To build the documentation:

make docs

To serve the documentation:

make docs-serve

Below are the full list of commands that can be run from the root folder:

make benchmark
make clean
make docs
make docs-clean
make docs-serve
make install
make install-docs
make lint
make run
make test
make typecheck

License

This project is licensed under the MIT License - see the LICENSE file for details.