Metadata-Version: 2.1
Name: aibo
Version: 0.0.1
Summary: aibo: AI partner that can run offline
Home-page: https://github.com/JUO-Inc/aibo
Author: Aibo Community
Author-email: koki.noda.contact@gmail.com
License: MIT
Keywords: LLM language model NLP speech deep learning transformer pytorch tensorflow GPT
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: pyttsx3
Requires-Dist: pyaudio
Requires-Dist: openai-whisper

# Aibo

The project aims to create an AI partner that can run offline.

# Features

- You can choose your favorite AI model as your aibo.
- You don't need to worry about security and privacy.
- You and Aibo can communicate by voice.

# Installation

## With pip

This repository is tested on Python 3.8+ and PyTorch 1.13.1+.

You should install aibo in a [virtual environment](https://docs.python.org/3/library/venv.html). If you're unfamiliar with Python virtual environments, check out the [user guide](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).

First, create a virtual environment with the version of Python you're going to use and activate it.

Then, you will need to install PyTorch.
Please refer to [PyTorch installation page](https://pytorch.org/get-started/locally/#start-locally) regarding the specific installation command for your platform.

When one of those backends has been installed, aibo can be installed using pip as follows:

```bash
pip install aibo
```

# Usage

First, configure the model you want to use, API, and API key. You can also set the parameters required for online execution at this point.

```bash
aibo init
```

Start aibo and start conversation in Englich. Your conversation history is stored in the history directory.

Offline execution is performed by appending "--offline" after this command.

```bash
aibo start
```

We support the following APIs for online execution;
ChatGPT API for chatting and Whisper API for transcription.
