ropensci / software-review

rOpenSci Software Peer Review.
286 stars 104 forks source link

Presubmission Inquiry: audrey (Client for the OpenAI's 'Whisper' Model) #597

Closed howardbaek closed 11 months ago

howardbaek commented 11 months ago

Submitting Author Name: Howard Baek Submitting Author Github Handle: !--author1-->@howardbaek<!--end-author1-- Repository: https://github.com/howardbaek/audrey Submission type: Pre-submission Language: en


Package: audrey
Title: Client for the OpenAI's 'Whisper' Model
Version: 0.0.0.9000
Authors@R: 
    person("Howard", "Baek", , "howardbaek.fh@gmail.com", role = c("aut", "cre"),
           comment = c(ORCID = "0009-0000-8942-1618"))
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.
License: MIT + file LICENSE
URL: https://github.com/howardbaek/audrey
BugReports: https://github.com/howardbaek/audrey/issues
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
SystemRequirements: Whisper. To install, follow the instructions provided in this link : <https://github.com/openai/whisper#setup> 
Imports: 
    cli,
    tools,
    withr
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3

Scope

This package interacts with the OpenAI Whisper by running system2(). Not sure if this qualifies as scientific software wrapper or data retrieval?

Anyone who wishes to use OpenAI's Whisper model to perform automatic speech recognition and translation into English.

This package, https://github.com/bnosac/audio.whisper, does the same thing and is an Rcpp wrapper around the whisper.cpp C++ library. This package is based on a CPU-only inference engine written in C++11, so no external software is needed and you can directly install and use it from R.

My package does require external software to be installed (Whisper + ffmpeg), but doesn't have any Rcpp and simply uses system2() to access OpenAI's Whisper model.

pkgcheck() keeps on telling me to "avoid long code lines, it is bad for readability.", but I'm not sure how to make code lines shorter automatically.

Also, I'm not sure how to fix these pkgcheck() messages:

Screenshot 2023-07-16 at 8 44 11 PM

maelle commented 11 months ago

:wave: @howardbaek, thanks for your submission!

We're wondering about overlap (https://devguide.ropensci.org/policies.html#overlap) with the audio.whisper package, that seems easier to install since it doesn't require any external software (https://ropensci.org/blog/2021/09/13/system-calls-r-package/#downsides-of-system-commands). Could you please comment on that?

howardbaek commented 11 months ago

I didn't know about those policies. I can close this issue.