diff --git a/docs/getting-started/getting-started.mdx b/docs/getting-started/getting-started.mdx index 4812e9f..2a587bb 100644 --- a/docs/getting-started/getting-started.mdx +++ b/docs/getting-started/getting-started.mdx @@ -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 diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx index 3de3b42..e942fe0 100644 --- a/docs/getting-started/introduction.mdx +++ b/docs/getting-started/introduction.mdx @@ -1,6 +1,6 @@ --- title: Introduction -description: "The open-source language model computer." +description: "The open-source language model computer" --- 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 ``` +### 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 = "" + +# 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 diff --git a/docs/software/installation.mdx b/docs/software/installation.mdx index 9fa80ad..28f13ca 100644 --- a/docs/software/installation.mdx +++ b/docs/software/installation.mdx @@ -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). diff --git a/docs/software/introduction.mdx b/docs/software/introduction.mdx new file mode 100644 index 0000000..2966a0b --- /dev/null +++ b/docs/software/introduction.mdx @@ -0,0 +1,8 @@ +--- +title: "Software" +description: "The software that powers 01" +--- + +## What is the server? + +## What is the client? diff --git a/docs/software/run.mdx b/docs/software/run.mdx index 92d34ad..d732145 100644 --- a/docs/software/run.mdx +++ b/docs/software/run.mdx @@ -5,13 +5,13 @@ description: "Run your 01" Make sure that you have navigated to the `software` directory. -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 01 Light, run the server: +To run the 01 server: ```bash poetry run 01 --server diff --git a/software/source/server/profiles/default.py b/software/source/server/profiles/default.py index 19ad475..3960162 100644 --- a/software/source/server/profiles/default.py +++ b/software/source/server/profiles/default.py @@ -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()