Skip to content

Commit e8fb518

Browse files
author
clams-bot
committed
adding metadata of distil-whisper-wrapper.v1.2
1 parent 3bf0597 commit e8fb518

File tree

5 files changed

+213
-15
lines changed

5 files changed

+213
-15
lines changed

‎docs/_apps/distil-whisper-wrapper/v1.2/index.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
layout: posts
3+
classes: wide
4+
title: "Distil Whisper Wrapper (v1.2)"
5+
date: 2024-08-08T15:48:34+00:00
6+
---
7+
## About this version
8+
9+
- Submitter: [BenLambright](https://github.com/BenLambright)
10+
- Submission Time: 2024-08-08T15:48:34+00:00
11+
- Prebuilt Container Image: [ghcr.io/clamsproject/app-distil-whisper-wrapper:v1.2](https://github.com/clamsproject/app-distil-whisper-wrapper/pkgs/container/app-distil-whisper-wrapper/v1.2)
12+
- Release Notes
13+
14+
> reverting back to HF pipeline using chunking transcription
15+
16+
## About this app (See raw [metadata.json](metadata.json))
17+
18+
**The wrapper of Distil-Whisper, avaliable models: distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. The default model is distil-small.en.**
19+
20+
- App ID: [http://apps.clams.ai/distil-whisper-wrapper/v1.2](http://apps.clams.ai/distil-whisper-wrapper/v1.2)
21+
- App License: Apache 2.0
22+
- Source Repository: [https://github.com/clamsproject/app-distil-whisper-wrapper](https://github.com/clamsproject/app-distil-whisper-wrapper) ([source tree of the submitted version](https://github.com/clamsproject/app-distil-whisper-wrapper/tree/v1.2))
23+
- Analyzer Version: 1.0
24+
- Analyzer License: MIT
25+
26+
27+
#### Inputs
28+
(**Note**: "*" as a property value means that the property is required but can be any value.)
29+
30+
One of the following is required: [
31+
- [http://mmif.clams.ai/vocabulary/AudioDocument/v1](http://mmif.clams.ai/vocabulary/AudioDocument/v1) (required)
32+
(of any properties)
33+
34+
- [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1) (required)
35+
(of any properties)
36+
37+
38+
39+
]
40+
41+
42+
#### Configurable Parameters
43+
(**Note**: _Multivalued_ means the parameter can have one or more values.)
44+
45+
- `modelSize`: optional, defaults to `distil-small.en`
46+
47+
- Type: string
48+
- Multivalued: False
49+
- Choices: `distil-large-v3`, `distil-large-v2`, `distil-medium.en`, **_`distil-small.en`_**, `small`, `s`, `medium`, `m`, `large-v2`, `l2`, `large-v3`, `l3`
50+
51+
52+
> The size of the model to use. There are four size of model to use distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. You can also enter the abbreviation of the model as parameter. 'small' and 's' for distil-small.en; 'medium' and 'm' for distil-medium.en; 'large-v2' and 'l2' for distil-large-v2; 'large-v3' and 'l3' for distil-large-v3. The default model is distil-medium.en.)
53+
- `pretty`: optional, defaults to `false`
54+
55+
- Type: boolean
56+
- Multivalued: False
57+
- Choices: **_`false`_**, `true`
58+
59+
60+
> The JSON body of the HTTP response will be re-formatted with 2-space indentation
61+
- `runningTime`: optional, defaults to `false`
62+
63+
- Type: boolean
64+
- Multivalued: False
65+
- Choices: **_`false`_**, `true`
66+
67+
68+
> The running time of the app will be recorded in the view metadata
69+
- `hwFetch`: optional, defaults to `false`
70+
71+
- Type: boolean
72+
- Multivalued: False
73+
- Choices: **_`false`_**, `true`
74+
75+
76+
> The hardware information (architecture, GPU and vRAM) will be recorded in the view metadata
77+
78+
79+
#### Outputs
80+
(**Note**: "*" as a property value means that the property is required but can be any value.)
81+
82+
(**Note**: Not all output annotations are always generated.)
83+
84+
- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
85+
- _@lang_ = "en"
86+
87+
> Fully serialized text content of the recognized text in the input audio/video.
88+
- [http://mmif.clams.ai/vocabulary/TimeFrame/v5](http://mmif.clams.ai/vocabulary/TimeFrame/v5)
89+
- _timeUnit_ = "milliseconds"
90+
91+
- [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
92+
(of any properties)
93+
94+
> Alignments between 1) `TimeFrame` <-> `SENTENCE`, 2) `audio/video document` <-> `TextDocument`
95+
- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
96+
(of any properties)
97+
98+
> The smallest recognized unit of distil-whisper. Normally a complete sentence.

‎docs/_apps/distil-whisper-wrapper/v1.2/metadata.json

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
{
2+
"name": "Distil Whisper Wrapper",
3+
"description": "The wrapper of Distil-Whisper, avaliable models: distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. The default model is distil-small.en.",
4+
"app_version": "v1.2",
5+
"mmif_version": "1.0.5",
6+
"analyzer_version": "1.0",
7+
"app_license": "Apache 2.0",
8+
"analyzer_license": "MIT",
9+
"identifier": "http://apps.clams.ai/distil-whisper-wrapper/v1.2",
10+
"url": "https://github.com/clamsproject/app-distil-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+
"description": "Fully serialized text content of the recognized text in the input audio/video.",
27+
"properties": {
28+
"@lang": "en"
29+
}
30+
},
31+
{
32+
"@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v5",
33+
"properties": {
34+
"timeUnit": "milliseconds"
35+
}
36+
},
37+
{
38+
"@type": "http://mmif.clams.ai/vocabulary/Alignment/v1",
39+
"description": "Alignments between 1) `TimeFrame` <-> `SENTENCE`, 2) `audio/video document` <-> `TextDocument`"
40+
},
41+
{
42+
"@type": "http://vocab.lappsgrid.org/Sentence",
43+
"description": "The smallest recognized unit of distil-whisper. Normally a complete sentence."
44+
}
45+
],
46+
"parameters": [
47+
{
48+
"name": "modelSize",
49+
"description": "The size of the model to use. There are four size of model to use distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. You can also enter the abbreviation of the model as parameter. 'small' and 's' for distil-small.en; 'medium' and 'm' for distil-medium.en; 'large-v2' and 'l2' for distil-large-v2; 'large-v3' and 'l3' for distil-large-v3. The default model is distil-medium.en.)",
50+
"type": "string",
51+
"choices": [
52+
"distil-large-v3",
53+
"distil-large-v2",
54+
"distil-medium.en",
55+
"distil-small.en",
56+
"small",
57+
"s",
58+
"medium",
59+
"m",
60+
"large-v2",
61+
"l2",
62+
"large-v3",
63+
"l3"
64+
],
65+
"default": "distil-small.en",
66+
"multivalued": false
67+
},
68+
{
69+
"name": "pretty",
70+
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
71+
"type": "boolean",
72+
"default": false,
73+
"multivalued": false
74+
},
75+
{
76+
"name": "runningTime",
77+
"description": "The running time of the app will be recorded in the view metadata",
78+
"type": "boolean",
79+
"default": false,
80+
"multivalued": false
81+
},
82+
{
83+
"name": "hwFetch",
84+
"description": "The hardware information (architecture, GPU and vRAM) will be recorded in the view metadata",
85+
"type": "boolean",
86+
"default": false,
87+
"multivalued": false
88+
}
89+
]
90+
}

‎docs/_apps/distil-whisper-wrapper/v1.2/submission.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"time": "2024-08-08T15:48:34+00:00",
3+
"submitter": "BenLambright",
4+
"image": "ghcr.io/clamsproject/app-distil-whisper-wrapper:v1.2",
5+
"releasenotes": "reverting back to HF pipeline using chunking transcription\n\n"
6+
}

‎docs/_data/app-index.json

+18-14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
11
{
2+
"http://apps.clams.ai/distil-whisper-wrapper": {
3+
"description": "The wrapper of Distil-Whisper, avaliable models: distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. The default model is distil-small.en.",
4+
"latest_update": "2024-08-08T15:48:34+00:00",
5+
"versions": [
6+
[
7+
"v1.2",
8+
"BenLambright"
9+
],
10+
[
11+
"v1.1",
12+
"keighrim"
13+
],
14+
[
15+
"v1.0",
16+
"1192119703jzx"
17+
]
18+
]
19+
},
220
"http://apps.clams.ai/simple-timepoints-stitcher": {
321
"description": "Stitches a sequence of `TimePoint` annotations into a sequence of `TimeFrame` annotations, performing simple smoothing of short peaks of positive labels.",
422
"latest_update": "2024-08-06T12:25:05+00:00",
@@ -129,20 +147,6 @@
129147
]
130148
]
131149
},
132-
"http://apps.clams.ai/distil-whisper-wrapper": {
133-
"description": "The wrapper of Distil-Whisper, avaliable models: distil-large-v3, distil-large-v2, distil-medium.en, distil-small.en. The default model is distil-small.en.",
134-
"latest_update": "2024-07-22T21:52:47+00:00",
135-
"versions": [
136-
[
137-
"v1.1",
138-
"keighrim"
139-
],
140-
[
141-
"v1.0",
142-
"1192119703jzx"
143-
]
144-
]
145-
},
146150
"http://apps.clams.ai/tfidf-keywordextractor": {
147151
"description": "extract keywords of a text document according to TF-IDF values. IDF values and all features come from related pickle files in the current directory.App can either take a simple text document or take a MMIF file generated from the text slicer app.",
148152
"latest_update": "2024-07-19T14:07:21+00:00",

‎docs/_data/apps.json

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

0 commit comments

Comments
 (0)