Skip to content

Commit

Permalink
update changelog, readme, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
ricky0123 committed Jun 1, 2024
1 parent e33df77 commit b1ead5a
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 10 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ PR without having completed all items.
- [ ] Viewed manual test site and verified that pages are working <!-- `npm run dev` -->
- [ ] Bumped versions in relevant packages
- [ ] Updated relevant changelogs <!-- see the `/changelogs` directory -->
- [ ] Ran `npm run format`
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This package aims to provide an accurate, user-friendly voice activity detector
* Join us on [Discord](https://discord.gg/4WPeGEaSpF)!
* Browse or contribute to [documentation](https://wiki.vad.ricky0123.com/)
* If you would like to contribute, I have started writing some documentation on how to get started hacking on these packages [here](https://wiki.vad.ricky0123.com/en/docs/developer/hacking). If you have any questions, you can open an issue here or leave a message on Discord.
* **NEW**: Please fill out this [survey](https://uaux2a2ppfv.typeform.com/to/iJG2gCQv) to let me know what you are building with these packages and how you are using them!

Under the hood, these packages run [Silero VAD](https://github.com/snakers4/silero-vad) [[1]](#1) using [ONNX Runtime Web](https://github.com/microsoft/onnxruntime/tree/main/js/web) / [ONNX Runtime Node.js](https://github.com/microsoft/onnxruntime/tree/main/js/node). Thanks a lot to those folks for making this possible.

Expand Down
4 changes: 4 additions & 0 deletions changelogs/node-changelog.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# @ricky0123/vad-node Changelog

## 0.0.3

* modify resampler to handle larger audio files
4 changes: 4 additions & 0 deletions changelogs/react-changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @ricky0123/vad-react Changelog

## 0.0.24

* Upgrade to vad-web 0.0.18

## 0.0.23

* Upgrade to vad-web 0.0.17
Expand Down
4 changes: 4 additions & 0 deletions changelogs/web-changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @ricky0123/vad-web Changelog

## 0.0.18

* use modified resampler

## 0.0.17

* look, by default, in web root for silero_vad.onnx and vad.bundle.min.js
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"offline-speech-recognition"
],
"homepage": "https://github.com/ricky0123/vad",
"version": "0.0.2",
"version": "0.0.3",
"license": "ISC",
"main": "dist/index.js",
"scripts": {
Expand Down
4 changes: 2 additions & 2 deletions packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
"react"
],
"homepage": "https://github.com/ricky0123/vad",
"version": "0.0.23",
"version": "0.0.24",
"license": "ISC",
"main": "dist/index.js",
"devDependencies": {
"@types/react": "^18.0.28"
},
"dependencies": {
"onnxruntime-web": "^1.14.0",
"@ricky0123/vad-web": "^0.0.17"
"@ricky0123/vad-web": "^0.0.18"
},
"peerDependencies": {
"react": "^18",
Expand Down
2 changes: 1 addition & 1 deletion packages/web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"offline-speech-recognition"
],
"homepage": "https://github.com/ricky0123/vad",
"version": "0.0.17",
"version": "0.0.18",
"license": "ISC",
"main": "dist/index.js",
"unpkg": "dist/bundle.min.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/web/src/real-time-vad.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export const defaultRealTimeVADOptions: RealTimeVADOptions = {
modelURL: assetPath("silero_vad.onnx"),
modelFetcher: defaultModelFetcher,
stream: undefined,
ortConfig: undefined
ortConfig: undefined,
}

export class MicVAD {
Expand Down

0 comments on commit b1ead5a

Please sign in to comment.