Skip to content

Commit d5ef8f8

Browse files
keighrimkeighrim
authored
Merge pull request #170 from clamsproject/register/0-distil-whisper-wrapper.v1.0
App Submitted - distil-whisper-wrapper.v1.0
2 parents 6480bc6 + 5908652 commit d5ef8f8

File tree

5 files changed

+174
-1
lines changed

5 files changed

+174
-1
lines changed

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

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
layout: posts
3+
classes: wide
4+
title: "Distil Whisper Wrapper (v1.0)"
5+
date: 2024-07-18T19:15:59+00:00
6+
---
7+
## About this version
8+
9+
- Submitter: [1192119703jzx](https://github.com/1192119703jzx)
10+
- Submission Time: 2024-07-18T19:15:59+00:00
11+
- Prebuilt Container Image: [ghcr.io/clamsproject/app-distil-whisper-wrapper:v1.0](https://github.com/clamsproject/app-distil-whisper-wrapper/pkgs/container/app-distil-whisper-wrapper/v1.0)
12+
- Release Notes
13+
14+
(no notes provided by the developer)
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.0](http://apps.clams.ai/distil-whisper-wrapper/v1.0)
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.0))
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+
62+
63+
#### Outputs
64+
(**Note**: "*" as a property value means that the property is required but can be any value.)
65+
66+
(**Note**: Not all output annotations are always generated.)
67+
68+
- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
69+
- _@lang_ = "en"
70+
71+
> Fully serialized text content of the recognized text in the input audio/video.
72+
- [http://mmif.clams.ai/vocabulary/TimeFrame/v5](http://mmif.clams.ai/vocabulary/TimeFrame/v5)
73+
- _timeUnit_ = "milliseconds"
74+
75+
- [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
76+
(of any properties)
77+
78+
> Alignments between 1) `TimeFrame` <-> `SENTENCE`, 2) `audio/video document` <-> `TextDocument`
79+
- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
80+
(of any properties)
81+
82+
> The smallest recognized unit of distil-whisper. Normally a complete sentence.

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

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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.0",
5+
"mmif_version": "1.0.4",
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.0",
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+
}

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

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"time": "2024-07-18T19:15:59+00:00",
3+
"submitter": "1192119703jzx",
4+
"image": "ghcr.io/clamsproject/app-distil-whisper-wrapper:v1.0"
5+
}

‎docs/_data/app-index.json

+10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
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-07-18T19:15:59+00:00",
5+
"versions": [
6+
[
7+
"v1.0",
8+
"1192119703jzx"
9+
]
10+
]
11+
},
212
"http://apps.clams.ai/spacy-wrapper": {
313
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
414
"latest_update": "2024-07-16T16:49:38+00:00",

‎docs/_data/apps.json

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

0 commit comments

Comments
 (0)