Skip to content

Commit 3017b6c

Browse files
committed
Added Moshi Docs
1 parent 8f530f9 commit 3017b6c

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
## 🔧 Other Guides
4949

5050
* [Using Window.ai](./guides/using-windowai.md)
51+
* [Using Moshi (Voice to Voice)](./guides/using-moshi.md)
5152

5253
## 🧩 Plugin System
5354

docs/guides/using-moshi.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Using Moshi (Voice to Voice)
3+
order: 3
4+
---
5+
6+
7+
To test Moshi, you need to set up and run **two servers** on Runpod (Or your running it on your own computer): **Amica** and **Moshi**. Follow these steps to get started:
8+
9+
---
10+
11+
### **Step 1: Set Up Working Environment**
12+
1. Once you’ve logged into your Runpod instance, navigate to the working directory:
13+
```bash
14+
cd /home
15+
```
16+
2. You will see two folders: `/amica` and `/moshi`.
17+
18+
---
19+
20+
### **Step 2: Open Two Terminals**
21+
You will need two bash terminals to run the servers simultaneously:
22+
- **Terminal 1**: To run the Amica server.
23+
- **Terminal 2**: To run the Moshi server.
24+
25+
---
26+
27+
### **Step 3: Run Amica Server**
28+
1. In **Terminal 1**, navigate to the **Amica** directory:
29+
```bash
30+
cd /home/amica
31+
```
32+
2. Install `npm` using the following commands:
33+
```bash
34+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
35+
nvm install node
36+
```
37+
3. Install dependencies and start the server:
38+
```bash
39+
npm install .
40+
npm run dev
41+
```
42+
4. The Amica server will start on **port 3000**.
43+
44+
---
45+
46+
### **Step 4: Run Moshi Server**
47+
1. In **Terminal 2**, navigate to the **Moshi** directory:
48+
```bash
49+
cd /home/moshi
50+
```
51+
2. Activate the Python virtual environment:
52+
```bash
53+
source env/bin/activate
54+
```
55+
3. Start the Moshi server:
56+
```bash
57+
uvicorn moshi_service:app --host 0.0.0.0 --port 8000
58+
```
59+
4. Wait for the server to download and load the required model. This may take a few minutes.
60+
61+
---
62+
63+
### **Step 5: Access the Servers**
64+
You can access the servers via Runpod's proxy URLs:
65+
- **Amica server**:
66+
`https://rnk7xoszvjhybh-3000.proxy.runpod.net/`
67+
- **Moshi server**:
68+
`https://rnk7xoszvjhybh-8000.proxy.runpod.net/`
69+
70+
Replace the `{port-number}` in the URL with the actual port number (3000 for Amica and 8000 for Moshi).
71+
72+
---

0 commit comments

Comments
 (0)