killian
10 months ago
committed by
GitHub
commit
edeb372af4
@ -1,37 +0,0 @@
|
|||||||
---
|
|
||||||
title: 01OS Settings
|
|
||||||
description: "Settings when running 01OS"
|
|
||||||
---
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
Runs the server
|
|
||||||
|
|
||||||
```bash Terminal
|
|
||||||
01 --server
|
|
||||||
```
|
|
||||||
|
|
||||||
### Expose
|
|
||||||
|
|
||||||
Expose an 01 server publically
|
|
||||||
|
|
||||||
```bash Terminal
|
|
||||||
01 --server --expose # This will print a URL that a client can point to.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Client
|
|
||||||
|
|
||||||
Runs a specific client
|
|
||||||
|
|
||||||
```bash Terminal
|
|
||||||
01 --client macos # Options: macos, rpi
|
|
||||||
```
|
|
||||||
|
|
||||||
### Local
|
|
||||||
|
|
||||||
The --local flag will install and run the whisper.cpp STT and Piper TTS models.
|
|
||||||
|
|
||||||
```bash Terminal
|
|
||||||
01 --local # Local client and server
|
|
||||||
01 --local --server --expose # Expose a local server
|
|
||||||
```
|
|
||||||
@ -1,105 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Environment Variables"
|
|
||||||
description: "Configure 01OS"
|
|
||||||
---
|
|
||||||
|
|
||||||
## ALL_LOCAL
|
|
||||||
|
|
||||||
Default:`False`
|
|
||||||
|
|
||||||
If `False`, we'll use OpenAI's services else we use whisper.cpp and piper local models
|
|
||||||
|
|
||||||
## WHISPER_MODEL_NAME
|
|
||||||
|
|
||||||
Default: `ggml-tiny.en.bin`
|
|
||||||
|
|
||||||
## WHISPER_MODEL_URL
|
|
||||||
|
|
||||||
Default: `https://huggingface.co/ggerganov/whisper.cpp/resolve/main/`
|
|
||||||
|
|
||||||
## TEACH_MODE
|
|
||||||
|
|
||||||
Default: `False`
|
|
||||||
|
|
||||||
Teach mode is a mode that allows you to teach 01OS new things. Disclaimer: This is a Developer Preview.
|
|
||||||
|
|
||||||
## OPENAI_API_KEY
|
|
||||||
|
|
||||||
Set your OpenAI API key
|
|
||||||
|
|
||||||
## PIPER_VOICE_URL
|
|
||||||
|
|
||||||
Default: `https://huggingface.co/rhasspy/piper-voices/resolve/main/en/en_US/lessac/medium/`
|
|
||||||
|
|
||||||
## PIPER_VOICE_NAME
|
|
||||||
|
|
||||||
Default: `en_US-lessac-medium.onnx`
|
|
||||||
|
|
||||||
For TTS, we use the `en_US-lessac-medium` voice model by default. Please change the voice URL and voice name if you wish to use another voice
|
|
||||||
|
|
||||||
## NGROK_AUTHTOKEN
|
|
||||||
|
|
||||||
Set to your [Ngrok auth token](https://dashboard.ngrok.com/get-started/your-authtoken)
|
|
||||||
|
|
||||||
## SERVER_URL
|
|
||||||
|
|
||||||
Default: `ws://0.0.0.0:8000/`
|
|
||||||
|
|
||||||
## SERVER_START
|
|
||||||
|
|
||||||
Default:`True`
|
|
||||||
This is where we'll serve the server
|
|
||||||
|
|
||||||
## CLIENT_START
|
|
||||||
|
|
||||||
Default: `True`
|
|
||||||
This is where the client expects the server to be.
|
|
||||||
|
|
||||||
## CLIENT_TYPE
|
|
||||||
|
|
||||||
Default: `auto`
|
|
||||||
|
|
||||||
Can explicitly set the client type (macos, rpi)
|
|
||||||
|
|
||||||
## CODE_RUNNER
|
|
||||||
|
|
||||||
Default: `server`
|
|
||||||
Control where various operations happen. Can be `client` or `server`.
|
|
||||||
|
|
||||||
## TTS_RUNNER
|
|
||||||
|
|
||||||
Default: `server`
|
|
||||||
If client, audio will be sent over websocket.
|
|
||||||
|
|
||||||
## STT_RUNNER
|
|
||||||
|
|
||||||
Default: `client`
|
|
||||||
If server, audio will be sent over websocket.
|
|
||||||
|
|
||||||
## SERVER_EXPOSE_PUBLICALLY
|
|
||||||
|
|
||||||
Default: `False`
|
|
||||||
|
|
||||||
Expose the server publically and display that URL.
|
|
||||||
|
|
||||||
## CAMERA_ENABLED
|
|
||||||
|
|
||||||
Default: `False`
|
|
||||||
|
|
||||||
## CAMERA_DEVICE_INDEX
|
|
||||||
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Camera device selection (Typically 0 for built-in, 1 for USB)
|
|
||||||
|
|
||||||
## CAMERA_WARMUP_SECONDS
|
|
||||||
|
|
||||||
Default: `0.4`
|
|
||||||
|
|
||||||
Camera warmup time is a workaround for some cameras that don't immediately return a properly exposed picture when they are first turned on
|
|
||||||
|
|
||||||
## LOG_LEVEL
|
|
||||||
|
|
||||||
Default: INFO
|
|
||||||
|
|
||||||
Can be `INFO` or `DEBUG`
|
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: "01 Heavy"
|
||||||
|
description: "Build your 01 Heavy"
|
||||||
|
---
|
||||||
|
|
||||||
|
runs fully locally + coming soon
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: "01 Light"
|
||||||
|
description: "Build your 01 Light"
|
||||||
|
---
|
||||||
|
|
||||||
|
01 Light (one pager that points to the STL, wiring diagrams, and points to the ESP32 client setup page^)
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
title: "Setup"
|
||||||
|
description: "Get your 01 client up and running"
|
||||||
|
---
|
||||||
|
|
||||||
|
(lets you pick from a grid of avaliable clients)
|
||||||
|
|
||||||
|
- ESP32 (instructions for flashing it)
|
||||||
|
- Desktop (basically says "just run start.py with no args, that will run the server with a client, or start.py --client to just run the client")
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: "Setup"
|
||||||
|
description: "Get your 01 up and running"
|
||||||
|
---
|
||||||
|
|
||||||
|
Setup (breaks down the basic steps of the following and links to the pages for more info)
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Hardware Guide"
|
|
||||||
sidebarTitle: "Hardware"
|
|
||||||
description: "How to use your Language Model Computer"
|
|
||||||
---
|
|
||||||
|
|
||||||
## 01 Light
|
|
||||||
|
|
||||||
- Connect to your 01 Light with the one click installer
|
|
||||||
- Enter your wifi details
|
|
||||||
- Follow instructions
|
|
||||||
- Push button to begin
|
|
||||||
|
|
||||||
## 01 Heavy
|
|
||||||
|
|
||||||
Coming soon
|
|
||||||
@ -1,55 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Software Guide"
|
|
||||||
sidebarTitle: "Software"
|
|
||||||
description: "Get 01OS up and running"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Install dependencies
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# MacOS
|
|
||||||
brew install portaudio ffmpeg
|
|
||||||
|
|
||||||
# Ubuntu
|
|
||||||
sudo apt-get install portaudio19-dev ffmpeg
|
|
||||||
```
|
|
||||||
|
|
||||||
## Setup for usage
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install 01OS
|
|
||||||
```
|
|
||||||
|
|
||||||
**Run the 01 end-to-end:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
01 # This will run a server + attempt to determine and run a client.
|
|
||||||
# (Behavior can be modified by changing the contents of `.env`)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Expose an 01 server publically:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
01 --server --expose # This will print a URL that a client can point to.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Run a specific client:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
01 --client macos # Options: macos, rpi
|
|
||||||
```
|
|
||||||
|
|
||||||
**Run locally:**
|
|
||||||
|
|
||||||
The current default uses OpenAI's services.
|
|
||||||
|
|
||||||
The `--local` flag will install and run the [whisper.cpp](https://github.com/ggerganov/whisper.cpp) STT and [Piper](https://github.com/rhasspy/piper) TTS models.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
01 --local # Local client and server
|
|
||||||
01 --local --server --expose # Expose a local server
|
|
||||||
```
|
|
||||||
|
|
||||||
**Configuration:**
|
|
||||||
|
|
||||||
Copy the `01OS/.env.example` file to `01OS/.env` then configure the environment variables within the file.
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: Adding Skills
|
|
||||||
description: "Teach 01OS new skills"
|
|
||||||
---
|
|
||||||
|
|
||||||
Sometimes the 01OS will run into a task it doesn't have the skills to do yet. When this happens, you can teach it a new skill using Teach Mode. Teach Mode consists of 3 steps: start teach mode, walk through and confirm each step, then exit teach mode.
|
|
||||||
|
|
||||||
## How To Teach
|
|
||||||
|
|
||||||
- < To start Teach Mode >
|
|
||||||
- cd ../01/01OS/ (we reccomend starting a virtual environment [would it be good to link to info on setting up a venv?])
|
|
||||||
- poetry run 01 --teach
|
|
||||||
- Enter the name of the skill you want to teach.
|
|
||||||
- Walk through the first step to show the 01OS what the action looks like.
|
|
||||||
- The 01OS will attempt to perform the first step.
|
|
||||||
- Confirm whether or not the 01OS successfully copied your action.
|
|
||||||
> - If it wasn't performed correctly, select "no" and adjust the prompt for the retrying.
|
|
||||||
> - If it was performed correctly, select "yes" and the code for that step will be added to the skill's python file
|
|
||||||
- Once you've finished all steps required to perform the skill, confirm that the skill is complete.
|
|
||||||
- The skill has been saved as a Python file, which the 01OS can now intelligently execute whenever your prompt would benefit from the skill.
|
|
||||||
|
|
||||||
_Disclaimer:_ We caution against showing any sensitive information on your screen while Teach Mode is running.
|
|
||||||
The developer preview version of 01OS collects data during Teach Mode that is used to train the 01OS for future versions.
|
|
||||||
Reach out to partnerships@openinterpreter.com with any questions or concerns. [Thoughs Mike? would it be better to setup privacy@openinterpreter.com or something lol?]
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
---
|
|
||||||
title: Introduction
|
|
||||||
description: "The 01 is a Language Model Computer. 01OS is its operating system"
|
|
||||||
---
|
|
||||||
|
|
||||||
<img
|
|
||||||
src="https://openinterpreter.com/assets/banner.jpg"
|
|
||||||
alt="thumbnail"
|
|
||||||
style={{ transform: "translateY(-1.25rem)" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The 01 Operating System (01OS) is open source software that operates computers using language models, powered by Open Interpreter.
|
|
||||||
This allows computers to understand natural language requests, and execute tasks on your behalf.
|
|
||||||
These guides will cover the steps for installing, using, and teaching 01OS.
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
The 01 Light is the interface with 01OS. It connects to your computer or our hosted service via the Internet or directly to an 01 Heavy (coming soon).
|
|
||||||
|
|
||||||
You can order a pre-made device or find instructions for building your own at openinterpreter.com/01OS/guides/hardware-guide.
|
|
||||||
You will always have the option to build your own device.
|
|
||||||
|
|
||||||
To connect to your device, use the one click installer.
|
|
||||||
|
|
||||||
_Disclaimer:_ The current version of 01OS is a developer preview.
|
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
title: "Setup"
|
||||||
|
description: "Get your 01 server up and running"
|
||||||
|
---
|
||||||
|
|
||||||
|
Setup (just run start.py --server , explain the flags (revealed via start.py --help))
|
||||||
|
|
||||||
|
- Interpreter
|
||||||
|
- Open Interpreter (explains i.py, how you configure your interpreter, cover the basic settings of OI (that file is literally just modifying an interpreter from OI)
|
||||||
|
- Language Model (LLM setup via interpreter.model in i.py or from the command line via start.py --server --llm-service llamafile)
|
||||||
|
- Voice Interface (explains that you can run --tts-service and --stt-service to swap out for different services, which are in /Services/Speech-to-text and /Services/Text-to-text)
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
title: "Language Model"
|
||||||
|
description: "The LLM that powers your 01"
|
||||||
|
---
|
||||||
|
|
||||||
|
- Llamafile (Local)
|
||||||
|
- Llamaedge (Local)
|
||||||
|
- Hosted Models (explains that we use litellm, you can pass in many different model flags to this)
|
||||||
|
- Add more (placeholder, we will add instructions soon)
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: "Speech To Text"
|
||||||
|
description: "Converts your voice into text"
|
||||||
|
---
|
||||||
|
|
||||||
|
- Whisper (Local)
|
||||||
|
- Whisper (Hosted)
|
||||||
|
- Add more (placeholder, we will add instructions soon)
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: "Text To Speech"
|
||||||
|
description: "Converts the text into audio"
|
||||||
|
---
|
||||||
|
|
||||||
|
- Piper (Local)
|
||||||
|
- OpenAI (Hosted)
|
||||||
|
- Add more (placeholder, we will add instructions soon)
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Setup"
|
|
||||||
description: "Get your 01 up and running"
|
|
||||||
---
|
|
||||||
|
|
||||||
## The 01
|
|
||||||
|
|
||||||
The 01 is a device that unleashes the power of controlling a Language Model Computer using only natural language.
|
|
||||||
Just connect it to the Internet and talk to it.
|
|
||||||
|
|
||||||
It's more than just voice control. It's a new way to use computers.
|
|
||||||
|
|
||||||
## One Click Installers
|
|
||||||
|
|
||||||
To connect your 01, select your one click installer:
|
|
||||||
|
|
||||||
- MacOS
|
|
||||||
- Linux
|
|
||||||
- Windows
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Hardware Build Guide"
|
|
||||||
description: "How to build your Language Model Computer"
|
|
||||||
---
|
|
||||||
|
|
||||||
## 01 Light
|
|
||||||
|
|
||||||
### Materials
|
|
||||||
|
|
||||||
- ATOM Echo Smart Speaker Development Kit
|
|
||||||
- PowerBoost 1000 Charger
|
|
||||||
- Tactile Switches 12MM TACTILE PB SWITCH
|
|
||||||
- Slide Switches DPDT THRU HOLE .3A
|
|
||||||
- Lithium Ion Polymer Battery - 3.7v 500mAh
|
|
||||||
- Silicone Cover Stranded-Core Wire 26AWG - Black, Red, Yellow
|
|
||||||
- Premium Male/Male Jumper Wires - 20 x 3" (75mm)
|
|
||||||
|
|
||||||
Optional
|
|
||||||
|
|
||||||
- Adafruit Mono 2.5W Class D Audio Amplifier - PAM8302
|
|
||||||
|
|
||||||
### Assembly
|
|
||||||
|
|
||||||
1. Gather Materials
|
|
||||||
2. Shove em together
|
|
||||||
|
|
||||||
## 01 Heavy
|
|
||||||
|
|
||||||
Coming soon
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Development"
|
|
||||||
description: "How to work on 01OS"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Setup for development:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone the repo, cd into the 01OS directory
|
|
||||||
git clone https://github.com/KillianLucas/01.git
|
|
||||||
cd 01OS
|
|
||||||
|
|
||||||
# Install dependencies, run the commands above
|
|
||||||
poetry install
|
|
||||||
poetry run 01
|
|
||||||
```
|
|
||||||
Loading…
Reference in new issue