nodejs-whisper - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/index.js

@@ -27,3 +27,2 @@ "use strict";
         const command = (0, WhisperHelper_1.constructCommand)(outputFilePath, options);
-        // console.log(`[Nodejs-whisper]  Executing command: ${command}\n`)
         const transcript = yield (0, whisper_1.executeCppCommand)(command);
@@ -30,0 +29,0 @@ return transcript;

package.json

 {
 	"name": "nodejs-whisper",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"description": "Node bindings for OpenAI's Whisper. Optimized for CPU.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 
+# nodejs-whisper
+
+Node.js bindings for OpenAI's Whisper model.
+
+
+
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+
+
+
+## Features
+ 
+- Automatically convert the audio to WAV format with a 16000 Hz    frequency to support the whisper model.
+- Output transcripts to (.txt .srt .vtt)
+- Optimized for CPU (Including Apple Silicon ARM)
+- Timestamp precision to single word
+- Split on word rather than on token (Optional)
+- Translate from source language to english (Optional)
+- Convert audio formet to wav to support whisper model
+
+
+## Installation
+
+1. Install nodejs-whisper with npm
+
+```bash
+  npm i nodejs-whisper
+```
+2.  Download whisper model
+```bash
+  npx nodejs-whisper download
+```
+    
+## Usage/Examples
+
+```javascript
+import path from 'path'
+import { nodewhisper } from "nodejs-whisper"
+
+// Need to provide exact path to your audio file.
+const filePath = path.resolve(__dirname, 'YourAudioFileName')
+
+await nodewhisper(filePath, {
+	modelName: 'base.en', //Downloaded models name
+	whisperOptions: {
+		outputInText: false, // get output result in txt file
+		outputInVtt: false, // get output result in vtt file
+		outputInSrt: true, // get output result in srt file
+		outputInCsv: false, // get output result in csv file
+		translateToEnglish: false,//translate from source language to english
+		wordTimestamps: false, // Word-level timestamps
+		timestamps_length: 20, // amount of dialogue per timestamp pair
+		splitOnWord: true, //split on word rather than on token
+	},
+})
+
+
+
+// Model list
+const MODELS_LIST = [
+	'tiny',
+	'tiny.en',
+	'base',
+	'base.en',
+	'small',
+	'small.en',
+	'medium',
+	'medium.en',
+	'large-v1',
+	'large',
+]
+```
+
+
+
+
+
+## Types
+
+```
+ interface IOptions {
+	modelName: string
+	whisperOptions?: WhisperOptions
+}
+
+ interface WhisperOptions {
+	outputInText?: boolean
+	outputInVtt?: boolean
+	outputInSrt?: boolean
+	outputInCsv?: boolean
+	translateToEnglish?: boolean
+	timestamps_length?: number
+	wordTimestamps?: boolean
+	splitOnWord?: boolean
+}
+
+```
+
+
+
+## Run Locally
+
+Clone the project
+
+```bash
+  git clone https://github.com/ChetanXpro/nodejs-whisper
+```
+
+Go to the project directory
+
+```bash
+  cd nodejs-whisper
+```
+
+Install dependencies
+
+```bash
+  npm install
+```
+
+Start the server
+
+```bash
+  npm run dev
+```
+
+Build Project
+
+```bash
+  npm run build
+```
+
+
+## Made with
+
+ - [Whisper OpenAI (using C++ port by: ggerganov)](https://github.com/ggerganov/whisper.cpp)
+
+## Feedback
+
+If you have any feedback, please reach out to us at [e-mail]
+
+
+## Authors
+
+- [@chetanXpro](https://www.github.com/chetanXpro)
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3837971

increased by0.07%

Number of lines in readme file

148

increased by7300%

Worsened metrics

Lines of code

3980

decreased by-0.03%

No dependency changes