Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App Submitted - whisper-wrapper.v4 #116

Merged
merged 1 commit into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions docs/_apps/whisper-wrapper/v4/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
layout: single
classes: wide
title: "Whisper Wrapper (v4)"
---
## About this version

* Submitter: [keighrim](https://github.com/keighrim)
* Submission Time: 2024-01-24T05:40:09+00:00
* Prebuilt Container Image: [ghcr.io/clamsproject/app-whisper-wrapper:v4](https://github.com/clamsproject/app-whisper-wrapper/pkgs/container/app-whisper-wrapper/v4)
* Release Notes

> * updated to the latest whisper models
> * now ouputs `Sentence` annotations based on whisper's segmentation

## About this app (See raw [metadata.json](metadata.json))

**A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.**

* App ID: [http://apps.clams.ai/whisper-wrapper/v4](http://apps.clams.ai/whisper-wrapper/v4)
* App License: Apache 2.0
* Source Repository: [https://github.com/clamsproject/app-whisper-wrapper](https://github.com/clamsproject/app-whisper-wrapper) ([source tree of the submitted version](https://github.com/clamsproject/app-whisper-wrapper/tree/v4))
* Analyzer Version: 20231117
* Analyzer License: MIT


#### Inputs
One of the following is required: [
* [http://mmif.clams.ai/vocabulary/AudioDocument/v1](http://mmif.clams.ai/vocabulary/AudioDocument/v1) (required)
(any properties)
* [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1) (required)
(any properties)


]


#### Configurable Parameters
**(_Multivalued_ means the parameter can have one or more values.)**

|Name|Description|Type|Multivalued|Default|Choices|
|----|-----------|----|-----------|-------|-------|
|modelSize|The size of the model to use. Can be "tiny", "base", "small", "medium", or "large".|string|N|tiny|**_`tiny`_**, `base`, `small`, `medium`, `large`|
|pretty|The JSON body of the HTTP response will be re-formatted with 2-space indentation|boolean|N|false|**_`false`_**, `true`|


#### Outputs
**(Note that not all output annotations are always generated.)**
* [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
(any properties)
* [http://mmif.clams.ai/vocabulary/TimeFrame/v1](http://mmif.clams.ai/vocabulary/TimeFrame/v1)
* _timeUnit_ = "seconds"
* [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
(any properties)
* [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
(any properties)
63 changes: 63 additions & 0 deletions docs/_apps/whisper-wrapper/v4/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
"name": "Whisper Wrapper",
"description": "A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.",
"app_version": "v4",
"mmif_version": "1.0.0",
"analyzer_version": "20231117",
"app_license": "Apache 2.0",
"analyzer_license": "MIT",
"identifier": "http://apps.clams.ai/whisper-wrapper/v4",
"url": "https://github.com/clamsproject/app-whisper-wrapper",
"input": [
[
{
"@type": "http://mmif.clams.ai/vocabulary/AudioDocument/v1",
"required": true
},
{
"@type": "http://mmif.clams.ai/vocabulary/VideoDocument/v1",
"required": true
}
]
],
"output": [
{
"@type": "http://mmif.clams.ai/vocabulary/TextDocument/v1"
},
{
"@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v1",
"properties": {
"timeUnit": "seconds"
}
},
{
"@type": "http://mmif.clams.ai/vocabulary/Alignment/v1"
},
{
"@type": "http://vocab.lappsgrid.org/Token"
}
],
"parameters": [
{
"name": "modelSize",
"description": "The size of the model to use. Can be \"tiny\", \"base\", \"small\", \"medium\", or \"large\".",
"type": "string",
"choices": [
"tiny",
"base",
"small",
"medium",
"large"
],
"default": "tiny",
"multivalued": false
},
{
"name": "pretty",
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
"type": "boolean",
"default": 0,
"multivalued": false
}
]
}
6 changes: 6 additions & 0 deletions docs/_apps/whisper-wrapper/v4/submission.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"time": "2024-01-24T05:40:09+00:00",
"submitter": "keighrim",
"image": "ghcr.io/clamsproject/app-whisper-wrapper:v4",
"releasenotes": "* updated to the latest whisper models\n* now ouputs `Sentence` annotations based on whisper's segmentation\n\n"
}
3 changes: 2 additions & 1 deletion docs/_data/app-index.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"http://apps.clams.ai/whisper-wrapper": [
"v1",
"v2",
"v3"
"v3",
"v4"
],
"http://apps.clams.ai/aapb-pua-kaldi-wrapper": [
"v1",
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/apps.json

Large diffs are not rendered by default.

Loading