Kanao Documentation

Welcome to the documentation for the Kanao project. Kanao is a project that includes a chatbot and various modules for processing different types of data.

README

# Kanao 📚

## Project Overview

Kanao is a project designed to train a GPT (Generative Pre-trained Transformer) model on custom datasets. It provides the capability to train the model using various data sources, including PDFs, Word documents, plain text files, and URLs.

## Features

- **Versatile Training**: Train the GPT model on diverse data types, including PDFs, Word documents, plain text files, and URLs.
- **Conversational AI**: Utilize the trained model for generating responses in a conversational manner.
- **Easy Integration**: Seamlessly integrate Kanao into your projects for natural language understanding and generation.

## Getting Started

To get started with Kanao, follow the installation instructions and examples in the [documentation](https://kanao.vercel.app/).

## Installation

```bash
pip install Kanao
```

## Usage

```python
from kanao.core.kanao import Kanao
open_ai_api_key = ""

# Initialize Kanao
kanao_instance = Kanao(open_ai_api_key)

# Train the model on custom data
kanao_instance.train_on_pdf('path/to/pdf/file.pdf')

# Generate a response
response_txt = kanao_instance.generate_response("What is in the document?")
```

For more detailed usage, refer to the [documentation](https://kanao.vercel.app/).

## Contribution

Contributions are welcome! Feel free to open issues or pull requests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Contents:

Installation

To install Kanao, follow the instructions in the [installation guide](installation.rst).

Usage

Learn how to use Kanao and its chatbot by reading the [usage guide](usage.rst).

Configuration

Configure Kanao by modifying the [config.ini](config.ini) file. Refer to the [configuration guide](configuration.rst) for details.

PDF Module

The PDF module in Kanao allows you to process PDF data. Read more in the [PDF module documentation](modules/pdf_module.rst).

Word Module

The Word module in Kanao allows you to process Word document data. Read more in the [Word module documentation](modules/word_module.rst).

URL Module

The URL module in Kanao allows you to process data from URLs. Read more in the [URL module documentation](modules/url_module.rst).

TXT Module

The TXT module in Kanao allows you to process plain text data. Read more in the [TXT module documentation](modules/txt_module.rst).

Contributing

If you'd like to contribute to Kanao, please follow the guidelines in the [contributing guide](contributing.rst).

Changelog

See the [changelog](changelog.rst) for information about updates and changes in each version of Kanao.