Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
waterflier committed Sep 29, 2023
1 parent fc0c91d commit a889761
Show file tree
Hide file tree
Showing 10 changed files with 145 additions and 298 deletions.
333 changes: 129 additions & 204 deletions README.md

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions doc/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,33 @@ With OpenDAN, we're putting AI in your hands, making life simpler and smarter.
This project is still in its very early stages, and there may be significant changes in the future.
## Installation

There are two ways to install the Internal Test Version of OpenDan:
There are two ways to install the Internal Test Version of OpenDAN:
1. Installation through docker, this is also the installation method we recommend now
2. Installing through the source code, this method may encounter some traditional Pyhont dependence problems and requires you to have a certain ability to solve.But if you want to do secondary development of OpenDan, this method is necessary.
2. Installing through the source code, this method may encounter some traditional Pyhont dependence problems and requires you to have a certain ability to solve.But if you want to do secondary development of OpenDAN, this method is necessary.

### Preparation before installation
1. Docker environment
This article does not introduce how to install the docker, execute it under your console
`` `
```
docker -version
`` `
```
If you can see the docker version number (> 20.0), it means that you have installed Docker.
If you don't know how to install docker, you can refer to [here] (https://docs.docker.com/engine/install/)
If you don't know how to install docker, you can refer to [here](https://docs.docker.com/engine/install/)

2. OpenAI API Token
If there is no api token, you can apply for [here] (https://beta.openai.com/)
If there is no api token, you can apply for [here](https://beta.openai.com/)
(Applying for the API Token may have some thresholds for new players. You can find friends around you, and you can give you a temporary, or join our internal test experience group. We will also release some free experience API token from time to time.These token is limited to the maximum consumption and effective time)

### Install OpenDan
After executing the following command, you can install the Docker Image of OpenDan
### Install OpenDAN
After executing the following command, you can install the Docker Image of OpenDAN
```
docker pull paios/aios:latest
```

## Run
The first Run of OpenDAN needs to be initialized. You need to enter some information in the process of initialization. Therefore, when starting the docker, remember to bring the -it parameter.

OpenDan is your Personal AIOS, so it will generate some important personal data (such as chat history with agent, schedule data, etc.) during its operation. These data will be stored on your local disk. ThereforeWe recommend that you mount the local disk into the container of Docker so that the data can be guaranteed.
OpenDAN is your Personal AIOS, so it will generate some important personal data (such as chat history with agent, schedule data, etc.) during its operation. These data will be stored on your local disk. ThereforeWe recommend that you mount the local disk into the container of Docker so that the data can be guaranteed.

```
docker run -v /your/local/myai/:/root/myai --name aios -it paios/aios:latest
Expand Down Expand Up @@ -79,7 +79,7 @@ The above configuration will be saved in the `/your/local/myai/etc/system.cfg.to


## (Optional) Install the local LLM kernel
For the first time quickly experience OpenDan, we strongly recommend you to use GPT4. Although he is very slow and expensive, he is also the most powerful and stable LLM core at present.OpenDan In the architecture design, different agents are allowed to choose different LLM kernels (but at least one available LLM kernel in the system should be available in the system). If you cannot use GPT4 for various reasons, you can use the Local LLM.
For the first time quickly experience OpenDAN, we strongly recommend you to use GPT4. Although he is very slow and expensive, he is also the most powerful and stable LLM core at present.OpenDAN In the architecture design, different agents are allowed to choose different LLM kernels (but at least one available LLM kernel in the system should be available in the system). If you cannot use GPT4 for various reasons, you can use the Local LLM.
At present, we only adapt to LOCAL LLM based on LLaMa.CPP, and use the following method to install

(Coming Soon)
Expand All @@ -96,7 +96,7 @@ Say Hello to your private AI assistant Jarvis !

You've successfully installed and configured OpenDAN, and verified that it's working properly. Now, let's quickly return to the familiar graphical interface, back to the mobile internet world!
We'll be registering a Telegram account for Jarvis. Through Telegram, you can communicate with Jarvis in a way that feels familiar.
In the opendan's aios_shell, type:
In the OpenDAN's aios_shell, type:
```
/connect Jarvis
```
Expand Down
Binary file added doc/res/design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/res/jarvis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/res/mvp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/res/workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 0 additions & 76 deletions rootfs/workflows/plan_maker/workflow.toml

This file was deleted.

2 changes: 1 addition & 1 deletion src/aios_kernel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@
from .stability_node import Stability_ComputeNode
from .local_st_compute_node import LocalSentenceTransformer_Text_ComputeNode,LocalSentenceTransformer_Image_ComputeNode

AIOS_Version = "0.5.1, build 2023-9-27"
AIOS_Version = "0.5.1, build 2023-9-28"

8 changes: 4 additions & 4 deletions src/aios_kernel/open_ai_node.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,10 @@ def is_support(self, task: ComputeTask) -> bool:
model_name : str = task.params["model_name"]
if model_name.startswith("gpt-"):
return True

if task.task_type == ComputeTaskType.TEXT_EMBEDDING:
if task.params["model_name"] == "text-embedding-ada-002":
return True
#if task.task_type == ComputeTaskType.TEXT_EMBEDDING:
# if task.params["model_name"] == "text-embedding-ada-002":
# return True
return False


Expand Down
2 changes: 0 additions & 2 deletions src/service/aios_shell/aios_shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ async def initial(self) -> bool:
knowledge_env = KnowledgeEnvironment("knowledge")
Environment.set_env_by_id("knowledge",knowledge_env)


cal_env = CalenderEnvironment("calender")
await cal_env.start()
Environment.set_env_by_id("calender",cal_env)
Expand All @@ -140,7 +139,6 @@ async def initial(self) -> bool:
return False
ComputeKernel.get_instance().add_compute_node(open_ai_node)


if await AIStorage.get_instance().is_feature_enable("llama"):
llama_ai_node = LocalLlama_ComputeNode()
if await llama_ai_node.initial() is True:
Expand Down

0 comments on commit a889761

Please sign in to comment.