Sneed-Group/ai-brain
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
ThatLinuxFan 2024-01-02 18:17:25 -06:00 committed by GitHub
parent 9ad1b91540
commit c4506a65e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -1,6 +1,6 @@
# The AI Brain Project # The AI Brain Project
The AI Brain Project is a Python program that demonstrates how to use OpenAI's GPT-3 language model to upload your brain to the cloud. The program asks the user for a name and generates random actions every 5 seconds, along with a random sentence using the GPT-3 model based on certain context. The program also allows the user to load custom context from a file. Think of it as [HLE](https://en.wikipedia.org/wiki/UltraHLE) for [brain emulation/mind uploading](https://en.wikipedia.org/wiki/Mind_uploading). Codenamed "Project GLaDOS" after the character from the Portal franchise, The AI Brain Project is a Python program that demonstrates how to use ollama to upload your brain to the cloud with just a description of yourself. The program asks the user for input generates random actions every 5 seconds. Think of it as [HLE](https://en.wikipedia.org/wiki/UltraHLE) for [brain emulation/mind uploading](https://en.wikipedia.org/wiki/Mind_uploading).
## Installation ## Installation
@ -9,13 +9,13 @@ To install the program, follow these steps:
Clone the repository: Clone the repository:
``` ```
git clone https://github.com/yourusername/ai-brain-project.git git clone https://github.com/The-AI-Brain/ai-brain-project.git
``` ```
Install the required Python packages: Install the required packages:
``` ```
pip install -r requirements.txt ./install-requirements-debian.sh
``` ```
Set up your OpenAI API key and name using the OpenAI Secret Manager. See the section on "Using the OpenAI Secret Manager" for more information. Set up your OpenAI API key and name using the OpenAI Secret Manager. See the section on "Using the OpenAI Secret Manager" for more information.
@ -26,47 +26,6 @@ Run the program:
python main.py python main.py
``` ```
## Usage
When you run the program, it will ask you for a name. Enter your name and press Enter. The program will then start generating actions and GPT-3 sentences every 5 seconds.
You can also load custom context from a file by placing a file named custom-context.txt in the same directory as main.py. The program will automatically load the context from the file if it exists.
Using the OpenAI Secret Manager
To keep your OpenAI API key and name secure, you can use the OpenAI Secret Manager to store them securely. To do this, follow these steps:
Create an account on the OpenAI website if you haven't already done so.
Log in to the OpenAI website and go to the "API keys" page.
Click "Generate new API key" to create a new API key.
Install the openai_secret_manager Python package:
```
pip install openai_secret_manager
```
Import the openai_secret_manager module in your Python code:
```
import openai_secret_manager
```
Use the openai_secret_manager.get_secret function to retrieve your API key and name (already in the code):
```
secrets = openai_secret_manager.get_secret("my_app_name")
openai.api_key = secrets["api_key"]
name = secrets["name"]
```
In the OpenAI Secret Manager, create a new secret with the name my_app_name and your API key and name as the values. You can also add other keys if needed.
Creating a new secret in the OpenAI Secret Manager
Save the secret in the OpenAI Secret Manager.
## License ## License
The AI Brain Project is licensed under the MIT License. See the LICENSE file for more information. The AI Brain Project is licensed under the MIT License. See the LICENSE file for more information.