# Qubee NLP Documentation

Qubee NLP is an open-source Natural Language Processing toolkit for **Afaan Oromoo**, providing tokenization, stemming, alphabet utilities, and extensible NLP components.


## 📘 Documentation

Complete documentation is available online:

👉 **https://qubee-nlp.readthedocs.io**

---

## 📚 Contents

### 🚀 Getting Started
- [Getting Started Guide](tutorials/getting_started.md)
- [Afaan Oromoo NLP Tutorial](tutorials/afaan_oromoo_nlp.md)



### 🧠 API Reference
- [Alphabet Module](api/alphabet.md)
- [Tokenizer Module](api/tokenizer.md)
- [Stemmer Module](api/stemmer.md)
- [Corpus Guide](api/Corpus.md)

### 💡 Examples
Explore practical examples in the `examples/` directory:
- **Basic Usage**
- **Tokenization Examples**
- **Stemming Examples**
- **Advanced Features**

### 🖥 Command Line Interface (CLI)
Qubee NLP also provides CLI utilities for:
- Tokenization
- Stemming
- Corpus processing
- Benchmarking

See the `scripts/` directory for available commands.




# Qubee NLP Documentation

Welcome to **Qubee NLP**, a comprehensive Natural Language Processing (NLP) library for **Afaan Oromoo (Oromo language)** using the **Qubee script**.

Qubee NLP is designed for researchers, developers, and institutions working on Afaan Oromoo language technologies.


## 📖 Overview

Qubee NLP provides tools for processing, analyzing, and understanding Afaan Oromoo text. The library includes:

* **Text Validation** – Validate Qubee script text
* **Tokenization** – Word and sentence tokenization
* **Normalization** – Text cleaning and standardization
* **Stemming** – Morphological analysis and stemming
* **POS Tagging** – Rule-based part-of-speech tagging
* **Stopword Removal** – Language-specific stopword lists
* **Syllabification** – Syllable segmentation



## 📦 Installation

```bash
pip install qubee-nlp