Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
openai
r
speech-to-text
whisper
Last synced: 9 months ago
·
JSON representation
Repository
Client to the OpenAI Whisper model
Basic Info
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
openai
r
speech-to-text
whisper
Created about 3 years ago
· Last pushed almost 3 years ago
Metadata Files
Readme
Contributing
License
Codemeta
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# audrey
audrey serves as a client to [OpenAI Whisper](https://github.com/openai/whisper), a general-purpose speech recognition model is trained on a large dataset of diverse audio. It can perform multilingual speech recognition, speech translation, and language identification.
## Installation
You can install the development version of audrey from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("howardbaek/audrey")
```
Importantly, you need to download Whisper with the following command:
```
pip install -U openai-whisper
```
You also need the command-line tool `ffmpeg` on your system:
```
# on Ubuntu or Debian
sudo apt update && sudo apt install ffmpeg
# on Arch Linux
sudo pacman -S ffmpeg
# on MacOS using Homebrew (https://brew.sh/)
brew install ffmpeg
# on Windows using Chocolatey (https://chocolatey.org/)
choco install ffmpeg
# on Windows using Scoop (https://scoop.sh/)
scoop install ffmpeg
```
For more information, refer to the Whisper's [Setup](https://github.com/openai/whisper#setup) documentation.
## Usage
### `transcribe()`
Convert the input audio file into written text using speech recognition, while preserving the language of the original audio:
```{r}
library(audrey)
transcribe(system.file("extdata", "sample-english1.mp3", package = "audrey"),
output_dir = ".")
```
### `translate()`
Provide an English translation of the input audio file that is originally spoken in a non-English language:
```{r}
# Korean to English
translate(system.file("extdata", "sample-korean.wav", package = "audrey"),
audio_lang = "Korean", output_dir = ".")
```
## Acknowledgements
- OpenAI [Whisper model](https://github.com/openai/whisper)
- Source of audio files: https://commonvoice.mozilla.org/en/datasets
Owner
- Name: Howard Baik
- Login: howardbaik
- Kind: user
- Website: howardbaik43@gmail.com
- Repositories: 330
- Profile: https://github.com/howardbaik
Project Data/Solution Engineer at Integral Consulting Inc.
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "audrey",
"description": "Perform speech recognition by converting spoken language from audio file into written text in its original language. Also, translate audio spoken in a non-English language into English.",
"name": "audrey: Client for the OpenAI's 'Whisper' Model",
"codeRepository": "https://github.com/howardbaek/audrey",
"issueTracker": "https://github.com/howardbaek/audrey/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.0.0.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.2.3 (2023-03-15)",
"author": [
{
"@type": "Person",
"givenName": "Howard",
"familyName": "Baek",
"email": "howardbaek.fh@gmail.com",
"@id": "https://orcid.org/0009-0000-8942-1618"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Howard",
"familyName": "Baek",
"email": "howardbaek.fh@gmail.com",
"@id": "https://orcid.org/0009-0000-8942-1618"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"version": ">= 3.0.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "cli",
"name": "cli",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=cli"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "tools",
"name": "tools"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "withr",
"name": "withr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=withr"
},
"SystemRequirements": "Whisper. To install, follow the instructions provided in this link : <https://github.com/openai/whisper#setup> "
},
"fileSize": "21064.306KB",
"readme": "https://github.com/howardbaek/audrey/blob/main/README.md",
"keywords": [
"openai",
"r",
"speech-to-text",
"whisper"
]
}GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0