Skip to content

Commit 65306f6

Browse files
author
clams-bot
committed
adding metadata of whisper-wrapper.v7
1 parent f504426 commit 65306f6

File tree

5 files changed

+213
-31
lines changed

5 files changed

+213
-31
lines changed

‎docs/_apps/whisper-wrapper/v7/index.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
layout: posts
3+
classes: wide
4+
title: "Whisper Wrapper (v7)"
5+
date: 2024-06-24T20:24:22+00:00
6+
---
7+
## About this version
8+
9+
- Submitter: [keighrim](https://github.com/keighrim)
10+
- Submission Time: 2024-06-24T20:24:22+00:00
11+
- Prebuilt Container Image: [ghcr.io/clamsproject/app-whisper-wrapper:v7](https://github.com/clamsproject/app-whisper-wrapper/pkgs/container/app-whisper-wrapper/v7)
12+
- Release Notes
13+
14+
> - Fixed minor typos in parameters
15+
> - Updated to clams-python 1.2.4, and added `cli.py` interface
16+
17+
## About this app (See raw [metadata.json](metadata.json))
18+
19+
**A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.**
20+
21+
- App ID: [http://apps.clams.ai/whisper-wrapper/v7](http://apps.clams.ai/whisper-wrapper/v7)
22+
- App License: Apache 2.0
23+
- 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/v7))
24+
- Analyzer Version: 20231117
25+
- Analyzer License: MIT
26+
27+
28+
#### Inputs
29+
(**Note**: "*" as a property value means that the property is required but can be any value.)
30+
31+
One of the following is required: [
32+
- [http://mmif.clams.ai/vocabulary/AudioDocument/v1](http://mmif.clams.ai/vocabulary/AudioDocument/v1) (required)
33+
(of any properties)
34+
35+
- [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1) (required)
36+
(of any properties)
37+
38+
39+
40+
]
41+
42+
43+
#### Configurable Parameters
44+
(**Note**: _Multivalued_ means the parameter can have one or more values.)
45+
46+
- `modelSize`: optional, defaults to `tiny`
47+
48+
- Type: string
49+
- Multivalued: False
50+
- Choices: **_`tiny`_**, `True`, `base`, `b`, `small`, `s`, `medium`, `m`, `large`, `l`, `large-v2`, `l2`, `large-v3`, `l3`
51+
52+
53+
> The size of the model to use. When `modelLang=en` is given, for non-`large` models, English-only models will be used instead of multilingual models for speed and accuracy. (For `large` models, English-only models are not available.)
54+
- `modelLang`: required
55+
56+
- Type: string
57+
- Multivalued: False
58+
59+
60+
> Language of the model to use, accepts two- or three-letter ISO 639 language codes, however Whisper only supports a subset of languages. If the language is not supported, error will be raised.For the full list of supported languages, see https://github.com/openai/whisper/blob/20231117/whisper/tokenizer.py . In addition to the langauge code, two-letter region codes can be added to the language code, e.g. "en-US" for US English. Note that the region code is only for compatibility and recording purpose, and Whisper neither detects regional dialects, nor use the given one for transcription. When the langauge code is not given, Whisper will run in langauge detection mode, and will use first few seconds of the audio to detect the language.
61+
- `pretty`: optional, defaults to `false`
62+
63+
- Type: boolean
64+
- Multivalued: False
65+
- Choices: **_`false`_**, `true`
66+
67+
68+
> The JSON body of the HTTP response will be re-formatted with 2-space indentation
69+
70+
71+
#### Outputs
72+
(**Note**: "*" as a property value means that the property is required but can be any value.)
73+
74+
(**Note**: Not all output annotations are always generated.)
75+
76+
- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
77+
(of any properties)
78+
79+
- [http://mmif.clams.ai/vocabulary/TimeFrame/v5](http://mmif.clams.ai/vocabulary/TimeFrame/v5)
80+
- _timeUnit_ = "milliseconds"
81+
82+
- [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
83+
(of any properties)
84+
85+
- [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
86+
(of any properties)
87+
88+
- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
89+
(of any properties)
90+

‎docs/_apps/whisper-wrapper/v7/metadata.json

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{
2+
"name": "Whisper Wrapper",
3+
"description": "A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.",
4+
"app_version": "v7",
5+
"mmif_version": "1.0.4",
6+
"analyzer_version": "20231117",
7+
"app_license": "Apache 2.0",
8+
"analyzer_license": "MIT",
9+
"identifier": "http://apps.clams.ai/whisper-wrapper/v7",
10+
"url": "https://github.com/clamsproject/app-whisper-wrapper",
11+
"input": [
12+
[
13+
{
14+
"@type": "http://mmif.clams.ai/vocabulary/AudioDocument/v1",
15+
"required": true
16+
},
17+
{
18+
"@type": "http://mmif.clams.ai/vocabulary/VideoDocument/v1",
19+
"required": true
20+
}
21+
]
22+
],
23+
"output": [
24+
{
25+
"@type": "http://mmif.clams.ai/vocabulary/TextDocument/v1"
26+
},
27+
{
28+
"@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v5",
29+
"properties": {
30+
"timeUnit": "milliseconds"
31+
}
32+
},
33+
{
34+
"@type": "http://mmif.clams.ai/vocabulary/Alignment/v1"
35+
},
36+
{
37+
"@type": "http://vocab.lappsgrid.org/Token"
38+
},
39+
{
40+
"@type": "http://vocab.lappsgrid.org/Sentence"
41+
}
42+
],
43+
"parameters": [
44+
{
45+
"name": "modelSize",
46+
"description": "The size of the model to use. When `modelLang=en` is given, for non-`large` models, English-only models will be used instead of multilingual models for speed and accuracy. (For `large` models, English-only models are not available.)",
47+
"type": "string",
48+
"choices": [
49+
"tiny",
50+
true,
51+
"base",
52+
"b",
53+
"small",
54+
"s",
55+
"medium",
56+
"m",
57+
"large",
58+
"l",
59+
"large-v2",
60+
"l2",
61+
"large-v3",
62+
"l3"
63+
],
64+
"default": "tiny",
65+
"multivalued": false
66+
},
67+
{
68+
"name": "modelLang",
69+
"description": "Language of the model to use, accepts two- or three-letter ISO 639 language codes, however Whisper only supports a subset of languages. If the language is not supported, error will be raised.For the full list of supported languages, see https://github.com/openai/whisper/blob/20231117/whisper/tokenizer.py . In addition to the langauge code, two-letter region codes can be added to the language code, e.g. \"en-US\" for US English. Note that the region code is only for compatibility and recording purpose, and Whisper neither detects regional dialects, nor use the given one for transcription. When the langauge code is not given, Whisper will run in langauge detection mode, and will use first few seconds of the audio to detect the language.",
70+
"type": "string",
71+
"default": "",
72+
"multivalued": false
73+
},
74+
{
75+
"name": "pretty",
76+
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
77+
"type": "boolean",
78+
"default": false,
79+
"multivalued": false
80+
}
81+
]
82+
}

‎docs/_apps/whisper-wrapper/v7/submission.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"time": "2024-06-24T20:24:22+00:00",
3+
"submitter": "keighrim",
4+
"image": "ghcr.io/clamsproject/app-whisper-wrapper:v7",
5+
"releasenotes": "- Fixed minor typos in parameters\n- Updated to clams-python 1.2.4, and added `cli.py` interface\n\n"
6+
}

‎docs/_data/app-index.json

+34-30
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,38 @@
11
{
2+
"http://apps.clams.ai/whisper-wrapper": {
3+
"description": "A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.",
4+
"latest_update": "2024-06-24T20:24:22+00:00",
5+
"versions": [
6+
[
7+
"v7",
8+
"keighrim"
9+
],
10+
[
11+
"v6",
12+
"keighrim"
13+
],
14+
[
15+
"v5",
16+
"keighrim"
17+
],
18+
[
19+
"v4",
20+
"keighrim"
21+
],
22+
[
23+
"v3",
24+
"keighrim"
25+
],
26+
[
27+
"v2",
28+
"keighrim"
29+
],
30+
[
31+
"v1",
32+
"keighrim"
33+
]
34+
]
35+
},
236
"http://apps.clams.ai/east-textdetection": {
337
"description": "OpenCV-based text localization app that used EAST text detection model. Please visit the source code repository for full documentation.",
438
"latest_update": "2024-06-24T13:52:29+00:00",
@@ -175,36 +209,6 @@
175209
]
176210
]
177211
},
178-
"http://apps.clams.ai/whisper-wrapper": {
179-
"description": "A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.",
180-
"latest_update": "2024-02-12T19:47:39+00:00",
181-
"versions": [
182-
[
183-
"v6",
184-
"keighrim"
185-
],
186-
[
187-
"v5",
188-
"keighrim"
189-
],
190-
[
191-
"v4",
192-
"keighrim"
193-
],
194-
[
195-
"v3",
196-
"keighrim"
197-
],
198-
[
199-
"v2",
200-
"keighrim"
201-
],
202-
[
203-
"v1",
204-
"keighrim"
205-
]
206-
]
207-
},
208212
"http://apps.clams.ai/easyocr-wrapper": {
209213
"description": "Using EasyOCR to extract text from timeframes",
210214
"latest_update": "2024-01-30T19:59:06+00:00",

‎docs/_data/apps.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)