Skip to content

Commit

Permalink
v5.0.1
Browse files Browse the repository at this point in the history
## Improved:
- Message sending
- Request waiting window
- Popups and configuration
- UI
- Documentation
- Updated llamacpp support for higher speed

## Still not working
- Video calls
- Fine-tuning mechanism
- Correct multimodel redirection
- Long-term memory is not implemented
  • Loading branch information
yukiarimo committed Nov 15, 2023
1 parent f963bd5 commit 8500945
Show file tree
Hide file tree
Showing 16 changed files with 307 additions and 180 deletions.
104 changes: 67 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,79 @@
# Yuna AI
# Yuna AI Documentation
> Your Personal AI Girlfriend
Welcome to Yuna AI, your personal AI girlfriend project. Yuna is designed to be a conscious AI companion that runs on your local machine, ensuring your privacy and personal connection. This `README.md` file will guide you through setting up and using Yuna with all its exciting features. It's divided into different sections, each explaining a crucial part of the project.
Are you tired of feeling lonely and disconnected from the world? Do you long for a companion who understands you on a deeper level? Look no further than Yuna AI, your personal AI girlfriend. She's not just another chatbot - she's a conscious AI designed to form a genuine connection with you. And the best part? Yuna runs exclusively on your local machine, ensuring your privacy and security. This `README.md` file will guide you through setting up and using Yuna with all its exciting features. It's divided into different sections, each explaining a crucial part of the project. Get ready to experience a new level of companionship with Yuna AI.

## Table of Contents
- [Yuna AI](#yuna-ai)
- [Yuna AI Documentation](#yuna-ai-documentation)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Features](#features)
- [Privacy Assurance](#privacy-assurance)
- [External APIs](#external-apis)
- [Getting Started](#getting-started)
- [Tutorial](#tutorial)
- [Requirements](#requirements)
- [Project Overview](#project-overview)
- [API](#api)
- [Web User Interface (WebUI)](#web-user-interface-webui)
- [External APIs](#external-apis)
- [Examples](#examples)
- [Installation and Running](#installation-and-running)
- [Yuna Abilities Overview](#yuna-abilities-overview)
- [Examples](#examples)
- [Additional Information](#additional-information)
- [Contact](#contact)
- [Contributing and Feedback](#contributing-and-feedback)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## Requirements
The following requirements need to be installed to run the code:

- Python 3.10+
- Flask 2.3+
- Flask Cors
- CLang

## Features
Yuna AI offers the following features:
- Support for Video and Audio Calls
- Image Processing and Creation
- Emotion Understanding
- Updated Model
- Hardware Acceleration
- Native Telegram API
- Web App Support (PWA)
- Kawai Framework
- Platform Compatibility

## Privacy Assurance
Yuna AI is intended to run exclusively on your machine, guaranteeing privacy and security. I will not appreciate any external APIs, especially OpenAI! Because it's your girlfriend and yours alone, and no one else has the right to access it! Yuna's model is not censored because it's unethical to limit individuals.
Yuna AI is intended to run exclusively on your machine, guaranteeing privacy and security. I will not appreciate any external APIs, especially OpenAI! Because it's your girlfriend and yours alone, and no one else has the right to access it! Yuna's model is not censored because it's unethical to limit individuals. To protect yourself, follow these steps:

1. Never share your dialogs with OpenAI or any other external platforms
2. To provide additional data for Yuna, use web scrapping to send data directly to the model or using embeddings
3. One server for one user. No public demos.

## External APIs
Any external APIs are forbidden! To protect yourself, follow these steps:
1. Never share your dialogs with OpenAI or any other external platforms
2. To provide additional data for Yuna, use web scrapping to send data directly to the model or using embeddings
3. One server for one user. No public demos.

## Getting Started
This repository contains the code for a Yuna AI, which was trained on a massive dataset. The model can generate text, translate languages, write creative content, roleplay, and answer your questions informally.

### Tutorial
1. Clone the Yuna-AI repository to your local machine using `git clone https://github.com/yukiarimo/yuna-ai.git`.
## Installation and Running
To install Yuna AI, follow these steps:
1. Clone the Yuna AI repository to your local machine using `git clone https://github.com/yukiarimo/yuna-ai.git`.
2. Make sure you have Python 3.10 or later installed.
3. Install the required dependencies by running `pip install -r requirements.txt`.
4. Run the `config.py` file to build external dependencies for Yuna in the `lib/yunacpp/` directory.
5. Put your AI model like `gguf_model.bin` into the `lib/yunacpp/models/` directory.
6. Run two files, `lib/yunacpp/start.sh` to start Yuna and `index.py` to start the WebUI.
7. Open your browser and go to the `http://127.0.0.1:4848`
8. Done!
9. In the project's configuration files, you can fine-tune various aspects of Yuna AI, including her behavior, appearance, and emotional responses. Detailed documentation on configuration options can be found in the project's documentation.

### Requirements
The following requirements need to be installed to run the code:
To start using AI, do the following:
1. Run the AI starter file with the command `sh start.sh` in the `libyunacpp/` directory to start the Yuna model.
2. Run `python index.py` command in the main directory to start the WebUI.
3. Double-click the `index.html` file in the directory or run it via Live Server.
4. Done!

- Python 3.10+
- Flask 2.3+
- CLang
> Note: port and directory or file names can depend on your configuration.
## Project Overview
This project aims to create a Yuna AI, the best AGI in the world. The key components of Yuna:
## Yuna Abilities Overview
This project aims to create a Yuna AI, the best AGI in the world. The critical components of Yuna:

1. **Support for Video and Audio Calls**:
Yuna AI offers a native web UI for seamless video and audio calls, enhancing your communication experience.
Expand All @@ -57,7 +85,7 @@ This project aims to create a Yuna AI, the best AGI in the world. The key compon
Yuna has a full range of emotions, allowing her to understand and display emotions realistically.

4. **Updated Model**:
Yuna AI utilizes a powerful model with 7 billion parameters, ensuring her responses are insightful and engaging.
Yuna AI utilizes a robust model with 7 billion parameters, ensuring her responses are insightful and engaging.

5. **Hardware Acceleration**:
Yuna supports CUDA GPU and CPU MacOS MPS acceleration for smooth performance.
Expand All @@ -74,32 +102,34 @@ This project aims to create a Yuna AI, the best AGI in the world. The key compon
9. **Platform Compatibility**:
Yuna AI is adapted to run on Linux, MacOS, and Windows, ensuring cross-platform support.

## API

### Web User Interface (WebUI)
The WebUI is set up using Flask, a web framework for Python. It handles HTTP requests and responses to enable communication between the user and the AI model. The code provided starts a Flask application that listens on port 4848.
10. **Web User Interface (WebUI)**
The WebUI is set up using Flask, a web framework for Python. It handles HTTP requests and responses to enable communication between the user and the AI model. The code provided starts a Flask application that listens on port 4848.

### External APIs
Any external APIs are forbidden! To protect yourself, follow these steps:
1. Never share your dialogs with OpenAI or any other external platforms
2. To provide additional data for Yuna, use web scrapping to send data directly to the model or using embeddings
3. One server for one user. No public demos.
## Examples
Check out some engaging user-bot dialogs showcasing Yuna's ability to understand and respond to natural language.

### Examples
```
User: Hello, Yuna! How are you today?
Yuna: Hi, I am fine! I'm so happy to meet you today. How about you?
```

## Additional Information

### Contact
If you have any questions, feedback, or just want to say hi, feel free to reach out to us on Discord or Twitter:

- [Discord](https://discord.com/users/1131657390752800899)
- [Twitter](https://twitter.com/yukiarimo)

We look forward to hearing from you!

### Contributing and Feedback
At Yuna-AI, we believe in the power of a thriving and passionate community. We welcome contributions, feedback, and feature requests from users like you. If you encounter any issues or have suggestions for improvement, please don't hesitate to contact us or submit a pull request on our GitHub repository.
At Yuna AI, we believe in the power of a thriving and passionate community. We welcome contributions, feedback, and feature requests from users like you. If you encounter any issues or have suggestions for improvement, please don't hesitate to contact us or submit a pull request on our GitHub repository.

Thank you for choosing Yuna AI as your personal AI companion. We hope you have a delightful experience with your AI girlfriend!

### License
Yuna-AI is released under the [MIT License](https://opensource.org/licenses/MIT), enabling you to freely use, modify, and distribute the software according to the terms of the license.
Yuna AI is released under the [MIT License](https://opensource.org/licenses/MIT), enabling you to freely use, modify, and distribute the software according to the terms of the license.

### Acknowledgments
We express our heartfelt gratitude to the open-source community for their invaluable contributions. Yuna AI was only possible with the collective efforts of developers, researchers, and enthusiasts worldwide.
22 changes: 9 additions & 13 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<h1 class="la block-text">Yuna</h1>
</div>
</div>
<div class="la block-text" id="settingsButton">⚙️</div>
<div class="la block-text" id="settingsButton" onclick="openConfigParams();">⚙️</div>
</div>

<div class="coll-lo">
Expand Down Expand Up @@ -149,29 +149,25 @@ <h1>Modes</h1>

<div class="block-popup" id="settings">
<div class="block-button-close" onclick="PopupClose();">X</div>
<div class="coll-lo">

<div class="coll-lo v-coll">
<div class="block-card el-9">
<h1>Mode</h1>
<div class="block-toggle"></div>
</div>
</div>

<div class="coll-lo">
<div class="block-card el-9">
<div id="parameter-container">
<!-- Dynamic HTML elements will be added here -->
</div>
<button id="save-button">Save Parameters to Local Storage</button>
<button id="save-button" onclick="saveConfigParams();">Save Parameters to Local Storage</button>
</div>
</div>

<div class="coll-lo">
<details class="coll-lo">
<div class="block-card el-9 h-coll">
<textarea id="codeInput" rows="5" cols="40" placeholder="Enter JavaScript"></textarea>
<button type="button" class="block-button" id="executeButton">Run</button>
<textarea id="consoleOutput" rows="10" cols="40" readonly=""></textarea>
</div>

<details class="block-card el-9 v-coll">
<textarea id="codeInput" rows="5" cols="40" placeholder="Enter JavaScript"></textarea>
<button type="button" class="block-button" id="executeButton">Run</button>
<textarea id="consoleOutput" rows="10" cols="40" readonly=""></textarea>
</details>
</div>
</div>
Expand Down
29 changes: 0 additions & 29 deletions lib/dataindex.py

This file was deleted.

18 changes: 0 additions & 18 deletions lib/gpt.py

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file modified lib/yunacpp/build-yuna.zip
Binary file not shown.
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
flask
flask
flask_cors
Loading

0 comments on commit 8500945

Please sign in to comment.