App Submitted - distil-whisper-wrapper.v1.0

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

@@ -0,0 +1,82 @@
+---
+layout: posts
+classes: wide
+title: "Distil Whisper Wrapper (v1.0)"
+date: 2024-07-17T22:27:16+00:00
+---
+## About this version
+
+- Submitter: [1192119703jzx](https://github.com/1192119703jzx)
+- Submission Time: 2024-07-17T22:27:16+00:00
+- 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)
+- Release Notes
+
+    (no notes provided by the developer)
+
+## About this app (See raw [metadata.json](metadata.json))
+
+**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.**
+
+- App ID: [http://apps.clams.ai/distil-whisper-wrapper/v1.0](http://apps.clams.ai/distil-whisper-wrapper/v1.0)
+- App License: Apache 2.0
+- 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))
+- Analyzer Version: 1.0
+- Analyzer License: MIT
+
+
+#### Inputs
+(**Note**: "*" as a property value means that the property is required but can be any value.)
+
+One of the following is required: [
+- [http://mmif.clams.ai/vocabulary/AudioDocument/v1](http://mmif.clams.ai/vocabulary/AudioDocument/v1) (required)
+(of any properties)
+
+- [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1) (required)
+(of any properties)
+
+
+
+]
+
+
+#### Configurable Parameters
+(**Note**: _Multivalued_ means the parameter can have one or more values.)
+
+- `modelSize`: optional, defaults to `distil-small.en`
+
+    - Type: string
+    - Multivalued: False
+    - Choices: `distil-large-v3`, `distil-large-v2`, `distil-medium.en`, **_`distil-small.en`_**, `small`, `s`, `medium`, `m`, `large-v2`, `l2`, `large-v3`, `l3`
+
+
+    > 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. The default model is distil-medium.en.)
+- `pretty`: optional, defaults to `false`
+
+    - Type: boolean
+    - Multivalued: False
+    - Choices: **_`false`_**, `true`
+
+
+    > The JSON body of the HTTP response will be re-formatted with 2-space indentation
+
+
+#### Outputs
+(**Note**: "*" as a property value means that the property is required but can be any value.)
+
+(**Note**: Not all output annotations are always generated.)
+
+- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
+    - _@lang_ = "en"
+
+    > Fully serialized text content of the recognized text in the input audio/video.
+- [http://mmif.clams.ai/vocabulary/TimeFrame/v5](http://mmif.clams.ai/vocabulary/TimeFrame/v5)
+    - _timeUnit_ = "milliseconds"
+
+- [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
+(of any properties)
+
+    > Alignments between 1) `TimeFrame` <-> `SENTENCE`, 2) `audio/video document` <-> `TextDocument`
+- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
+(of any properties)
+
+    > The smallest recognized unit of distil-whisper. Normally a complete sentence.

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

@@ -0,0 +1,76 @@
+{
+  "name": "Distil Whisper Wrapper",
+  "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.",
+  "app_version": "v1.0",
+  "mmif_version": "1.0.4",
+  "analyzer_version": "1.0",
+  "app_license": "Apache 2.0",
+  "analyzer_license": "MIT",
+  "identifier": "http://apps.clams.ai/distil-whisper-wrapper/v1.0",
+  "url": "https://github.com/clamsproject/app-distil-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",
+      "description": "Fully serialized text content of the recognized text in the input audio/video.",
+      "properties": {
+        "@lang": "en"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v5",
+      "properties": {
+        "timeUnit": "milliseconds"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/Alignment/v1",
+      "description": "Alignments between 1) `TimeFrame` <-> `SENTENCE`, 2) `audio/video document` <-> `TextDocument`"
+    },
+    {
+      "@type": "http://vocab.lappsgrid.org/Sentence",
+      "description": "The smallest recognized unit of distil-whisper. Normally a complete sentence."
+    }
+  ],
+  "parameters": [
+    {
+      "name": "modelSize",
+      "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. The default model is distil-medium.en.)",
+      "type": "string",
+      "choices": [
+        "distil-large-v3",
+        "distil-large-v2",
+        "distil-medium.en",
+        "distil-small.en",
+        "small",
+        "s",
+        "medium",
+        "m",
+        "large-v2",
+        "l2",
+        "large-v3",
+        "l3"
+      ],
+      "default": "distil-small.en",
+      "multivalued": false
+    },
+    {
+      "name": "pretty",
+      "description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
+      "type": "boolean",
+      "default": false,
+      "multivalued": false
+    }
+  ]
+}

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

@@ -0,0 +1,5 @@
+{
+  "time": "2024-07-17T22:27:16+00:00",
+  "submitter": "1192119703jzx",
+  "image": "ghcr.io/clamsproject/app-distil-whisper-wrapper:v1.0"
+}

docs/_data/app-index.json

@@ -1,4 +1,14 @@
 {
+  "http://apps.clams.ai/distil-whisper-wrapper": {
+    "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.",
+    "latest_update": "2024-07-17T22:27:16+00:00",
+    "versions": [
+      [
+        "v1.0",
+        "1192119703jzx"
+      ]
+    ]
+  },
   "http://apps.clams.ai/spacy-wrapper": {
     "description": "Apply spaCy NLP to all text documents in a MMIF file.",
     "latest_update": "2024-07-16T16:49:38+00:00",