https://github.com/appleboy/whisper-action
Speech-to-Text using ggerganov/whisper.cpp for GitHub Action
https://github.com/appleboy/whisper-action
Last synced: 9 months ago
JSON representation
Speech-to-Text using ggerganov/whisper.cpp for GitHub Action
- Host: GitHub
- URL: https://github.com/appleboy/whisper-action
- Owner: appleboy
- License: mit
- Created: 2023-07-01T08:45:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T06:21:02.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T08:31:07.046Z (9 months ago)
- Language: Shell
- Size: 507 KB
- Stars: 16
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# whisper-action
Speech-to-Text using [ggerganov/whisper.cpp](https://github.com/ggerganov/whisper.cpp) for [GitHub Action](https://github.com/features/actions). High-performance inference of OpenAI Whisper automatic speech recognition (ASR) model.
## Inputs variables
See [action.yml](./action.yml) for more detailed information.
| Variable | Description | Default |
|------------------|--------------------------------------------------------------|---------|
| model | public whisper model. (available: small, medium and large) | small |
| audio_path | Audio Path. | |
| output_folder | output folder. | |
| output_format | output format, support txt, srt, csv. | txt |
| output_filename | output filename. | |
| debug | enable debug mode. | |
| print_progress | print progress. | true |
| print_segment | print segment. | |
| youtube_url | youtube url | |
| translate | translate from source language to english. | false |
| cut_silences | cut silences. | false |
| prompt | initial prompt text. | |
## Usage
Donwload Youtube video and transcript it.
```yaml
jobs:
youtube-eng-video:
name: transcript english video
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
- name: speech to text
uses: appleboy/whisper-action@v0.1.1
with:
model: small
youtube_url: https://www.youtube.com/watch?v=pTCxXZh6VyE
output_format: srt
output_folder: youtube
print_segment: true
debug: true
- name: git push changes
uses: appleboy/git-push-action@v0.0.2
with:
branch: main
commit: true
commit_message: "[skip ci] Upload changes"
remote: git@github.com:appleboy/whisper-action.git
ssh_key: ${{ secrets.DEPLOY_KEY }}
rebase: true
```
See the output file in youtube folder.