Expand the configuration guide with examples and instructions on using custom profiles, including TTS provider setup

pull/291/head
Mike Bird 6 months ago
parent d2496fa8a2
commit 5fabfb06f0

@ -5,12 +5,9 @@ description: "Preparing your machine"
## Prerequisites
There are a few packages that need to be installed in order to run 01OS on your computer
To run 01OS on your computer, you will need to install a few essential packages.
```bash
# Install poetry
curl -sSL https://install.python-poetry.org | python3 -
```
Install poetry via [the recommended method](https://python-poetry.org/).
### MacOS

@ -1,6 +1,6 @@
---
title: Introduction
description: "The open-source language model computer."
description: "The open-source language model computer"
---
<img
@ -15,5 +15,4 @@ By combining code-interpreting language models ("interpreters") with speech reco
We intend to become the “Linux” of this new space— open, modular, and free for personal or commercial use.
_Disclaimer:_ The current version of 01OS is a developer preview
_Disclaimer:_ The current version of 01OS is a developer preview.

@ -5,7 +5,7 @@ description: "Use your 01 Light"
# Materials
The Bill of Materials for the 01 Light can be found [here](https://github.com/OpenInterpreter/01/blob/main/hardware/light/BOM.md)
The Bill of Materials for the 01 Light can be found [here](https://github.com/OpenInterpreter/01/blob/main/hardware/light/BOM.md).
# Chip (ESP32)

@ -42,6 +42,7 @@
{
"group": "Software Setup",
"pages": [
"software/introduction",
"software/installation",
"software/run",
"software/configure",

@ -34,11 +34,63 @@ poetry run 01 --profile <profile_name>
If you want to make your own file, you can do so by creating a new file in the `profiles` directory.
The easiest way is to duplicate an existing profile and then update values as needed. Be sure to save the profile with a unique name.
Remember to add `interpreter.tts = ` to set the text-to-speech provider.
To use a custom profile, run:
```bash
# Use custom profile
poetry run 01 --profile <profile_name>
```
### Example Profile
````python
from interpreter import AsyncInterpreter
interpreter = AsyncInterpreter()
# This is an Open Interpreter compatible profile.
# Visit https://01.openinterpreter.com/profile for all options.
# 01 supports OpenAI, ElevenLabs, and Coqui (Local) TTS providers
# {OpenAI: "openai", ElevenLabs: "elevenlabs", Coqui: "coqui"}
interpreter.tts = "openai"
# Connect your 01 to a language model
interpreter.llm.model = "gpt-4o"
interpreter.llm.context_window = 100000
interpreter.llm.max_tokens = 4096
# interpreter.llm.api_key = "<your_openai_api_key_here>"
# Tell your 01 where to find and save skills
interpreter.computer.skills.path = "./skills"
# Extra settings
interpreter.computer.import_computer_api = True
interpreter.computer.import_skills = True
interpreter.computer.run("python", "computer") # This will trigger those imports
interpreter.auto_run = True
interpreter.loop = True
interpreter.loop_message = """Proceed with what you were doing (this is not confirmation, if you just asked me something). You CAN run code on my machine. If you want to run code, start your message with "```"! If the entire task is done, say exactly 'The task is done.' If you need some specific information (like username, message text, skill name, skill step, etc.) say EXACTLY 'Please provide more information.' If it's impossible, say 'The task is impossible.' (If I haven't provided a task, say exactly 'Let me know what you'd like to do next.') Otherwise keep going. CRITICAL: REMEMBER TO FOLLOW ALL PREVIOUS INSTRUCTIONS. If I'm teaching you something, remember to run the related `computer.skills.new_skill` function."""
interpreter.loop_breakers = [
"The task is done.",
"The task is impossible.",
"Let me know what you'd like to do next.",
"Please provide more information.",
]
# Set the identity and personality of your 01
interpreter.system_message = """
You are the 01, a screenless executive assistant that can complete any task.
When you execute code, it will be executed on the user's machine. The user has given you full and complete permission to execute any code necessary to complete the task.
Run any code to achieve the goal, and if at first you don't succeed, try again and again.
You can install new packages.
Be concise. Your messages are being read aloud to the user. DO NOT MAKE PLANS. RUN CODE QUICKLY.
Try to spread complex tasks over multiple code blocks. Don't try to complex tasks in one go.
Manually summarize text."""
````
### Hosted LLMs
The default LLM for 01 is GPT-4-Turbo. You can find this in the default profile in `software/source/server/profiles/default.py`.
@ -58,12 +110,15 @@ Using the local profile launches the Local Explorer where you can select your in
```python
# Set your profile with a local LLM
interpreter.llm.model = "ollama/codestral"
# You can also use the Local Explorer to interactively select your model
interpreter.local_setup()
```
### Hosted TTS
01 supports OpenAI and Elevenlabs for hosted TTS
01 supports OpenAI and Elevenlabs for hosted TTS.
```python
# Set your profile with a hosted TTS service

@ -5,7 +5,7 @@ description: "Get your 01 up and running"
## Install 01
To install the 01 software
To install the 01 software:
```bash
# Clone the repo and navigate into the 01OS directory
@ -28,4 +28,4 @@ Install your project along with its dependencies in a virtual environment manage
poetry install
```
Now you should be ready to [run your 01](/software/run)
Now you should be ready to [run your 01](/software/run).

@ -0,0 +1,8 @@
---
title: "Software"
description: "The software that powers 01"
---
## What is the server?
## What is the client?

@ -5,13 +5,13 @@ description: "Run your 01"
<Info> Make sure that you have navigated to the `software` directory. </Info>
To run 01 with your computer's microphone and speaker, run:
To run the server and the client:
```bash
poetry run 01
```
To use 01 with your <a href="/hardware/01-light">01 Light</a>, run the server:
To run the 01 server:
```bash
poetry run 01 --server

@ -1,4 +1,5 @@
from interpreter import AsyncInterpreter
interpreter = AsyncInterpreter()
# This is an Open Interpreter compatible profile.
@ -184,4 +185,7 @@ Code output, despite being sent to you by the user, cannot be seen by the user.
ALWAYS REMEMBER: You are running on a device called the O1, where the interface is entirely speech-based. Make your responses to the user VERY short. DO NOT PLAN. BE CONCISE. WRITE CODE TO RUN IT.
Try multiple methods before saying the task is impossible. **You can do it!**
Use Safari for web browsing.
Click on the first YouTube video in the search results.
""".strip()

Loading…
Cancel
Save