An open-source Python package for conversational AI with support for Nigerian languages, including Pidgin, Yoruba, Hausa, and Igbo.
# π **Padie** π
**Padie** is an evolving, open-source Python package designed to enable conversational AI systems with support for Nigerian languages, including **Pidgin**, **Yoruba**, **Hausa**, and **Igbo**. It aims to provide AI-powered tools for **language detection**, **intent recognition**, and **response generation**, while fostering community collaboration to enhance its capabilities.
> **π§ Note:** Padie is a work in progress. Models are being trained and refined, and weβre actively gathering datasets to improve accuracy. Your contributions can make a difference!
---
## β¨ **Features**
- π **AI-Powered Language Detection**
Automatically identify the language of input text across supported Nigerian languages.
- π― **AI-Powered Intent Recognition**
Accurately understand user intentions across multiple domains and contexts.
- π€ **Dynamic Response Generation**
Generate intelligent, context-aware responses tailored to user input.
- βοΈ **Framework-Agnostic Design**
Seamlessly integrate Padie into any framework or application.
- π§βπ€βπ§ **Community Contributions**
An open platform for developers, linguists, and AI enthusiasts to contribute datasets, models, and features.
---
## π οΈ **Handling Datasets and Citations**
### **Dataset Format**
Datasets should follow a structured format. Each entry must include at least the following fields:
```json
{
"text": "Example input text.",
"label": "language_label",
"format": "format_type",
"source": {
"provider": null,
"url": null
},
"citation": null
}
```
### **Citations**
- If the data includes a citation, create a **unique citation code** (e.g., `"c1"`, `"c2"`) and add the citation details to a separate file named `citations.json`.
- Replace the citation field in the dataset with the corresponding code.
#### **Example Citation File (citations.json):**
```json
{
"c2": {
"title": "Naija Language Translation",
"author": "Wazobia",
"year": 2021,
"url": "
example.com"
}
}
```
# β¦