Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs edit #300

Merged
merged 9 commits into from
Sep 6, 2024
55 changes: 42 additions & 13 deletions docs/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,41 @@ title: "Getting Started"
description: "Preparing your machine"
---

## Prerequisites
## Overview

The 01 project is an open-source ecosystem for artificially intelligent devices. By combining code-interpreting language models ("interpreters") with speech recognition and voice synthesis, the 01's flagship operating system ("01") can power conversational, computer-operating AI devices similar to the Rabbit R1 or the Humane Pin.

Our goal is to become the "Linux" of this new space—open, modular, and free for personal or commercial use.

<Note>The current version of 01 is a developer preview.</Note>

## Components

The 01 consists of two main components:

### Server

The server runs on your computer and acts as the brain of the 01 system. It:

- Passes input to the interpreter
- Executes commands on your computer
- Returns responses

### Client

The client is responsible for capturing audio for controlling computers running the 01 server. It:

- Transmits audio to the server
- Plays back responses

# Prerequisites

To run the 01 on your computer, you will need to install a few essential packages.

#### What is Poetry?

Poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. We use Poetry to ensure that everyone running 01 has the same environment and dependencies.

<Card
title="Install Poetry"
icon="link"
Expand All @@ -15,11 +46,9 @@ To run the 01 on your computer, you will need to install a few essential package
To install poetry, follow the official guide here.
</Card>

## What is Poetry?

Poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. We use Poetry to ensure that everyone running 01 has the same environment and dependencies.
### Operating Systems

### MacOS
#### MacOS

On MacOS, we use Homebrew (a package manager) to install the required dependencies. Run the following command in your terminal:

Expand All @@ -29,11 +58,11 @@ brew install portaudio ffmpeg cmake

This command installs:

- PortAudio: A cross-platform audio I/O library
- FFmpeg: A complete, cross-platform solution for recording, converting, and streaming audio and video
- CMake: An open-source, cross-platform family of tools designed to build, test and package software
- [PortAudio](https://www.portaudio.com/): A cross-platform audio I/O library
Copy link
Collaborator

@KillianLucas KillianLucas Sep 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I love all these links/resources

- [FFmpeg](https://www.ffmpeg.org/): A complete, cross-platform solution for recording, converting, and streaming audio and video
- [CMake](https://cmake.org/): An open-source, cross-platform family of tools designed to build, test and package software

### Ubuntu
#### Ubuntu

<Note>Wayland not supported, only Ubuntu 20.04 and below</Note>

Expand All @@ -43,11 +72,11 @@ sudo apt-get install portaudio19-dev ffmpeg cmake

This command installs:

- PortAudio: A cross-platform audio I/O library
- FFmpeg: A complete solution for recording, converting, and streaming audio and video
- CMake: An open-source, cross-platform family of tools designed to build, test and package software
- [PortAudio](https://www.portaudio.com/): A cross-platform audio I/O library
- [FFmpeg](https://www.ffmpeg.org/): A complete solution for recording, converting, and streaming audio and video
- [CMake](https://cmake.org/): An open-source, cross-platform family of tools designed to build, test and package software

### Windows
#### Windows

- [Git for Windows](https://git-scm.com/download/win).
- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
Expand Down
34 changes: 34 additions & 0 deletions docs/hardware/mobile/community-apps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "Community Apps"
description: "Apps built by the community"
---

## Native iOS app by [eladekkal](https://github.com/eladdekel).

To run it on your device, you can either install the app directly through the current TestFlight [here](https://testflight.apple.com/join/v8SyuzMT), or build from the source code files in Xcode on your Mac.

### Instructions

- [Install 01 software](/software/installation) on your machine

- In Xcode, open the 'zerooone-app' project file in the project folder, change the Signing Team and Bundle Identifier, and build.

### Using the App

To use the app there are four features:

1. The speak "Button"

Made to emulate the button on the hardware models of 01, the big, yellow circle in the middle of the screen is what you hold when you want to speak to the model, and let go when you're finished speaking.

2. The settings button

Tapping the settings button will allow you to input your websocket address so that the app can properly connect to your computer.

3. The reconnect button

The arrow will be RED when the websocket connection is not live, and GREEN when it is. If you're making some changes you can easily reconnect by simply tapping the arrow button (or you can just start holding the speak button, too!).

4. The terminal button

The terminal button allows you to see all response text coming in from the server side of the 01. You can toggle it by tapping on the button, and each toggle clears the on-device cache of text.
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: "Android"
description: "Control 01 from your Android phone"
title: "Development"
description: "How to get your 01 mobile app"
---

Using your phone is a great way to control 01. There are multiple options available.

## [React Native app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile)

Work in progress, we will continue to improve this application.
Expand Down
15 changes: 15 additions & 0 deletions docs/hardware/mobile/download.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Download"
description: "How to get your 01 mobile app"
---

Using your phone is a great way to control 01. There are multiple options available.

<CardGroup cols={2}>
<Card title="iOS" icon="apple">
Coming soon
</Card>
<Card title="Android" icon="android">
Coming soon
</Card>
</CardGroup>
73 changes: 0 additions & 73 deletions docs/hardware/mobile/ios.mdx

This file was deleted.

85 changes: 85 additions & 0 deletions docs/legal/privacy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Privacy Policy"
---

Last updated: August 8th, 2024

## 1. Introduction

Welcome to the 01 App. We are committed to protecting your privacy and providing a safe, AI-powered chat experience. This Privacy Policy explains how we collect, use, and protect your information when you use our app.

## 2. Information We Collect

### 2.1 When Using Our Cloud Service

If you choose to use our cloud service, we collect and store:

- Your email address
- Transcriptions of your interactions with our AI assistant
- Any images you send to or receive from the AI assistant

### 2.2 When Using Self-Hosted Server

If you connect to your own self-hosted server, we do not collect or store any of your data, including your email address.

## 3. How We Use Your Information

We use the collected information solely for the purpose of providing and improving our AI chat service. This includes:

- Facilitating communication between you and our AI assistant
- Improving the accuracy and relevance of AI responses
- Analyzing usage patterns to enhance user experience

## 4. Data Storage and Security

We take appropriate measures to protect your data from unauthorized access, alteration, or destruction. All data is stored securely and accessed only by authorized personnel.

## 5. Data Sharing and Third-Party Services

We do not sell, trade, or otherwise transfer your personally identifiable information to outside parties. This does not include trusted third parties who assist us in operating our app, conducting our business, or servicing you, as long as those parties agree to keep this information confidential.

We may use third-party services for analytics and app functionality. These services may collect anonymous usage data to help us improve the app.

## 6. Data Retention and Deletion

We retain your data for as long as your account is active or as needed to provide you services. If you wish to cancel your account or request that we no longer use your information, please contact us using the information in Section 11.

## 7. Your Rights

You have the right to:

- Access the personal information we hold about you
- Request correction of any inaccurate information
- Request deletion of your data from our systems

To exercise these rights, please contact us using the information provided in Section 11.

## 8. Children's Privacy

Our app is not intended for children under the age of 13. We do not knowingly collect personal information from children under 13. If you are a parent or guardian and you are aware that your child has provided us with personal information, please contact us.

## 9. International Data Transfer

Your information, including personal data, may be transferred to — and maintained on — computers located outside of your state, province, country or other governmental jurisdiction where the data protection laws may differ from those in your jurisdiction.

## 10. Changes to This Privacy Policy

We may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on this page and updating the "Last updated" date.

## 11. Contact Us

If you have any questions about this Privacy Policy, please contact us at:

Email: help@openinterpreter.com

## 12. California Privacy Rights

If you are a California resident, you have the right to request information regarding the disclosure of your personal information to third parties for direct marketing purposes, and to opt-out of such disclosures. As stated in this Privacy Policy, we do not share your personal information with third parties for direct marketing purposes.

## 13. Cookies and Tracking

Our app does not use cookies or web tracking technologies.

## 14. Consent

By using the 01 App, you consent to this Privacy Policy.
9 changes: 5 additions & 4 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@
{
"group": "Mobile",
"pages": [
"hardware/mobile/ios",
"hardware/mobile/android",
"hardware/mobile/privacy"
"hardware/mobile/download",
"hardware/mobile/development",
"hardware/mobile/community-apps"
]
}
]
Expand All @@ -99,7 +99,8 @@
{
"group": "Legal",
"pages": [
"legal/fulfillment-policy"
"legal/fulfillment-policy",
"legal/privacy"
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion docs/software/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/server/introduction).
10 changes: 1 addition & 9 deletions docs/software/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
---
title: "Software"
title: "Overview"
description: "The software that powers 01"
---

## Overview

The 01 project is an open-source ecosystem for artificially intelligent devices. By combining code-interpreting language models ("interpreters") with speech recognition and voice synthesis, the 01's flagship operating system ("01") can power conversational, computer-operating AI devices similar to the Rabbit R1 or the Humane Pin.

Our goal is to become the "Linux" of this new space—open, modular, and free for personal or commercial use.

<Note>The current version of 01 is a developer preview.</Note>

## Components

The 01 software consists of two main components:
Expand Down
2 changes: 1 addition & 1 deletion docs/software/server/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "The servers that powers 01"
<Card title="Light" href="/software/server/light-server">
Light Server
</Card>
<Card title="Livekit" href="/software/server/livekit">
<Card title="Livekit" href="/software/server/livekit-server">
Livekit Server
</Card>
</CardGroup>
Expand Down
Loading
Loading