Xenova HF staff commited on
Commit
042af3c
·
verified ·
1 Parent(s): 802ab2d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +50 -3
README.md CHANGED
@@ -1,12 +1,59 @@
1
  ---
2
- title: Kokoro Webgpu
3
- emoji: 👀
4
  colorFrom: yellow
5
  colorTo: green
6
  sdk: static
7
  pinned: false
8
  license: apache-2.0
9
  short_description: High-quality speech synthesis powered by Kokoro TTS
 
 
 
 
 
 
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Kokoro Text-to-Speech (WebGPU)
3
+ emoji: 🗣️⚡
4
  colorFrom: yellow
5
  colorTo: green
6
  sdk: static
7
  pinned: false
8
  license: apache-2.0
9
  short_description: High-quality speech synthesis powered by Kokoro TTS
10
+ header: mini
11
+ models:
12
+ - onnx-community/Kokoro-82M-ONNX
13
+ custom_headers:
14
+ cross-origin-embedder-policy: require-corp
15
+ cross-origin-opener-policy: same-origin
16
+ cross-origin-resource-policy: cross-origin
17
  ---
18
 
19
+ # Kokoro Text-to-Speech (WebGPU)
20
+
21
+ A simple React + Vite application for running [Kokoro](https://github.com/hexgrad/kokoro), a frontier text-to-speech model for its size using Transformers.js.
22
+
23
+ ## Getting Started
24
+
25
+ Follow the steps below to set up and run the application.
26
+
27
+ ### 1. Clone the Repository
28
+
29
+ Clone the examples repository from GitHub:
30
+
31
+ ```sh
32
+ git clone https://github.com/hexgrad/kokoro.git
33
+ ```
34
+
35
+ ### 2. Navigate to the Project Directory
36
+
37
+ Change your working directory to the `demo` folder:
38
+
39
+ ```sh
40
+ cd kokoro/kokoro.js/demo
41
+ ```
42
+
43
+ ### 3. Install Dependencies
44
+
45
+ Install the necessary dependencies using npm:
46
+
47
+ ```sh
48
+ npm i
49
+ ```
50
+
51
+ ### 4. Run the Development Server
52
+
53
+ Start the development server:
54
+
55
+ ```sh
56
+ npm run dev
57
+ ```
58
+
59
+ The application should now be running locally. Open your browser and go to `http://localhost:5173` to see it in action.