semvec/pypi-packages huggingface dataset:
askedith 0.31.2
Natural Language Query Engine for Pandas
License: Apache 2.0
Requires Python: >=3.6

<p align="center">
    <br>
    <br>
    <br>
    <a href="https://askedith.ai">
        <img
            src="https://media-exp2.licdn.com/dms/image/C560BAQFxV92mCa43Eg/company-logo_200_200/0/1656093924337?e=1665619200&v=beta&t=yY1oHTgLHavsDDV9nALJjuGrVxG-GaiWvuyxgs4ohg4"
            alt="AskEdith logo: AskEdith is a Natural Language Query Engine"
            width="200px"
        >
    </a>
    <br>
    <br>
</p>

<p align="center">
    <b>Natural Language Query Engine for Pandas</b>
    <br>
    <br>
    <a href="https://discord.gg/dyPry7j2qs">
        <img
            src="https://img.shields.io/badge/Discord-Join-%237289DA?style=flat-square&logo=appveyor"
            alt="Badge"
        >
    </a>
    <a href="https://pypi.org/project/askedith/">
        <img
            src="https://img.shields.io/badge/Release-0.31.2-blue?style=flat-square&logo=appveyor"
            alt="Badge"
        >
    </a>
    <a href="https://pypi.org/project/askedith/">
        <img
            src="https://img.shields.io/badge/CI%2FCD-passing-green?style=flat-square&logo=appveyor"
            alt="Badge"
        >
    </a>
</p>

AskEdith is a data analytics question-answering system that can help you speed up your data analytics workflows. AskEdith converts your natural language questions into SQL queries that are used to return a computed DataFrame.

## How It Works

1. ETL / Ingress - AskEdith ingresses data and parses schema and metadata.
2. Semantic Search to relate relevant sections of data to the question.
3. NLP Language Model to convert natural language to SQL.
4. Execute on input DataFrame and return results.

## Installation

```bash
pip install askedith
```

## Usage

```python
import pandas as pd
import askedith

# Load Avocados Data (https://figshare.com/articles/dataset/avocado_csv/17696882)
df = pd.read_csv("https://figshare.com/ndownloader/files/35259799")

# Use AskEdith
df = df.askedith.ask("What's the average price for organic avocados?")

print(df)
```

## Examples

[![Example](https://i.imgur.com/JVnJiyM.png)](https://i.imgur.com/JVnJiyM.png)
[![Example](https://i.imgur.com/qHqSBCh.png)](https://i.imgur.com/qHqSBCh.png)