nekomeowww commited on
Commit
f579272
·
1 Parent(s): 1b37d87

release: build 3aa30bb8a90a618ada99308a8dd1700f461561f3

Browse files
Files changed (1) hide show
  1. README.md +71 -0
README.md ADDED
@@ -0,0 +1,71 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Moonshine Web (Vue)
3
+ emoji: 🌙
4
+ colorFrom: blue
5
+ colorTo: pink
6
+ sdk: static
7
+ pinned: false
8
+ license: apache-2.0
9
+ models:
10
+ - onnx-community/moonshine-base-ONNX
11
+ short_description: Yet another Real-time in-browser STT, re-implemented in Vue
12
+ thumbnail: https://raw.githubusercontent.com/moeru-ai/airi/refs/heads/main/packages/whisper-webgpu/public/banner.png
13
+ ---
14
+
15
+ <h1 align="center">Moonshine Web (Vue)</h1>
16
+
17
+ <p align="center">
18
+ [<a href="https://moonshine-web-vue.netlify.app/">Try it</a>]
19
+ </p>
20
+
21
+ > Heavily inspired by [Realtime in-browser speech recognition](https://huggingface.co/spaces/webml-community/moonshine-web)
22
+
23
+ # Moonshine Web
24
+
25
+ A simple Vue + Vite application for running [Moonshine Base](https://huggingface.co/onnx-community/moonshine-base-ONNX), a powerful speech-to-text model optimized for fast and accurate automatic speech recognition (ASR) on resource-constrained devices. It runs locally in the browser using Transformers.js and WebGPU-acceleration (or WASM as a fallback).
26
+
27
+ ## Getting Started
28
+
29
+ Follow the steps below to set up and run the application.
30
+
31
+ ### 1. Clone the Repository
32
+
33
+ Clone the examples repository from GitHub:
34
+
35
+ ```sh
36
+ git clone https://github.com/moeru-ai/airi.git
37
+ ```
38
+
39
+ ### 2. Navigate to the Project Directory
40
+
41
+ Change your working directory to the `moonshine-web` folder:
42
+
43
+ ```sh
44
+ cd packages/moonshine-web
45
+ ```
46
+
47
+ ### 3. Install Dependencies
48
+
49
+ Install the necessary dependencies using npm:
50
+
51
+ ```sh
52
+ npm i
53
+ ```
54
+
55
+ ### 4. Run the Development Server
56
+
57
+ Start the development server:
58
+
59
+ ```sh
60
+ npm run dev
61
+ ```
62
+
63
+ The application should now be running locally. Open your browser and go to `http://localhost:5175` to see it in action.
64
+
65
+ ## Acknowledgements
66
+
67
+ The audio visualizer was adapted from Wael Yasmina's [amazing tutorial](https://waelyasmina.net/articles/how-to-create-a-3d-audio-visualizer-using-three-js/).
68
+
69
+ Great thanks to what Xenova have done.
70
+
71
+ > [Source code](https://github.com/huggingface/transformers.js-examples/tree/38a883dd465d70d7368b86b95aa0678895ca4e83/moonshine-web)