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 - swt-detection.v6.1 #175

Merged
merged 1 commit into from
Jul 30, 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
154 changes: 154 additions & 0 deletions docs/_apps/swt-detection/v6.1/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
layout: posts
classes: wide
title: "Scenes-with-text Detection (v6.1)"
date: 2024-07-30T01:06:00+00:00
---
## About this version

- Submitter: [keighrim](https://github.com/keighrim)
- Submission Time: 2024-07-30T01:06:00+00:00
- Prebuilt Container Image: [ghcr.io/clamsproject/app-swt-detection:v6.1](https://github.com/clamsproject/app-swt-detection/pkgs/container/app-swt-detection/v6.1)
- Release Notes

> SDK update to fix warning view bugs

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

**Detects scenes with text, like slates, chyrons and credits.**

- App ID: [http://apps.clams.ai/swt-detection/v6.1](http://apps.clams.ai/swt-detection/v6.1)
- App License: Apache 2.0
- Source Repository: [https://github.com/clamsproject/app-swt-detection](https://github.com/clamsproject/app-swt-detection) ([source tree of the submitted version](https://github.com/clamsproject/app-swt-detection/tree/v6.1))


#### Inputs
(**Note**: "*" as a property value means that the property is required but can be any value.)

- [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.)

- `startAt`: optional, defaults to `0`

- Type: integer
- Multivalued: False


> Number of milliseconds into the video to start processing
- `stopAt`: optional, defaults to `9223372036854775807`

- Type: integer
- Multivalued: False


> Number of milliseconds into the video to stop processing
- `sampleRate`: optional, defaults to `1000`

- Type: integer
- Multivalued: False


> Milliseconds between sampled frames
- `minFrameScore`: optional, defaults to `0.01`

- Type: number
- Multivalued: False


> Minimum score for a still frame to be included in a TimeFrame
- `minTimeframeScore`: optional, defaults to `0.5`

- Type: number
- Multivalued: False


> Minimum score for a TimeFrame
- `minFrameCount`: optional, defaults to `2`

- Type: integer
- Multivalued: False


> Minimum number of sampled frames required for a TimeFrame
- `modelName`: optional, defaults to `convnext_lg`

- Type: string
- Multivalued: False
- Choices: `convnext_tiny`, **_`convnext_lg`_**


> model name to use for classification
- `usePosModel`: optional, defaults to `true`

- Type: boolean
- Multivalued: False
- Choices: `false`, **_`true`_**


> Use the model trained with positional features
- `useStitcher`: optional, defaults to `true`

- Type: boolean
- Multivalued: False
- Choices: `false`, **_`true`_**


> Use the stitcher after classifying the TimePoints
- `allowOverlap`: optional, defaults to `true`

- Type: boolean
- Multivalued: False
- Choices: `false`, **_`true`_**


> Allow overlapping time frames
- `map`: optional, defaults to `['B:bars', 'S:slate', 'I:chyron', 'N:chyron', 'Y:chyron', 'C:credits', 'R:credits', 'W:other_opening', 'L:other_opening', 'O:other_opening', 'M:other_opening', 'E:other_text', 'K:other_text', 'G:other_text', 'T:other_text', 'F:other_text']`

- Type: map
- Multivalued: True


> Mapping of a label in the input annotations to a new label. Must be formatted as IN_LABEL:OUT_LABEL (with a colon). To pass multiple mappings, use this parameter multiple times. By default, all the input labels are passed as is, including any negative labels (with default value being no remapping at all). However, when at least one label is remapped, all the other "unset" labels are discarded as a negative label.
- `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
- `runningTime`: optional, defaults to `false`

- Type: boolean
- Multivalued: False
- Choices: **_`false`_**, `true`


> The running time of the app will be recorded in the view metadata
- `hwFetch`: optional, defaults to `false`

- Type: boolean
- Multivalued: False
- Choices: **_`false`_**, `true`


> The hardware information (architecture, GPU and vRAM) will be recorded in the view metadata


#### 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/TimeFrame/v5](http://mmif.clams.ai/vocabulary/TimeFrame/v5)
- _timeUnit_ = "milliseconds"

- [http://mmif.clams.ai/vocabulary/TimePoint/v4](http://mmif.clams.ai/vocabulary/TimePoint/v4)
- _timeUnit_ = "milliseconds"
- _labelset_ = a list of ["B", "S", "W", "L", "O", "M", "I", "N", "E", "P", "Y", "K", "G", "T", "F", "C", "R"]

169 changes: 169 additions & 0 deletions docs/_apps/swt-detection/v6.1/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
{
"name": "Scenes-with-text Detection",
"description": "Detects scenes with text, like slates, chyrons and credits.",
"app_version": "v6.1",
"mmif_version": "1.0.5",
"app_license": "Apache 2.0",
"identifier": "http://apps.clams.ai/swt-detection/v6.1",
"url": "https://github.com/clamsproject/app-swt-detection",
"input": [
{
"@type": "http://mmif.clams.ai/vocabulary/VideoDocument/v1",
"required": true
}
],
"output": [
{
"@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v5",
"properties": {
"timeUnit": "milliseconds"
}
},
{
"@type": "http://mmif.clams.ai/vocabulary/TimePoint/v4",
"properties": {
"timeUnit": "milliseconds",
"labelset": [
"B",
"S",
"W",
"L",
"O",
"M",
"I",
"N",
"E",
"P",
"Y",
"K",
"G",
"T",
"F",
"C",
"R"
]
}
}
],
"parameters": [
{
"name": "startAt",
"description": "Number of milliseconds into the video to start processing",
"type": "integer",
"default": 0,
"multivalued": false
},
{
"name": "stopAt",
"description": "Number of milliseconds into the video to stop processing",
"type": "integer",
"default": 9223372036854775807,
"multivalued": false
},
{
"name": "sampleRate",
"description": "Milliseconds between sampled frames",
"type": "integer",
"default": 1000,
"multivalued": false
},
{
"name": "minFrameScore",
"description": "Minimum score for a still frame to be included in a TimeFrame",
"type": "number",
"default": 0.01,
"multivalued": false
},
{
"name": "minTimeframeScore",
"description": "Minimum score for a TimeFrame",
"type": "number",
"default": 0.5,
"multivalued": false
},
{
"name": "minFrameCount",
"description": "Minimum number of sampled frames required for a TimeFrame",
"type": "integer",
"default": 2,
"multivalued": false
},
{
"name": "modelName",
"description": "model name to use for classification",
"type": "string",
"choices": [
"convnext_tiny",
"convnext_lg"
],
"default": "convnext_lg",
"multivalued": false
},
{
"name": "usePosModel",
"description": "Use the model trained with positional features",
"type": "boolean",
"default": true,
"multivalued": false
},
{
"name": "useStitcher",
"description": "Use the stitcher after classifying the TimePoints",
"type": "boolean",
"default": true,
"multivalued": false
},
{
"name": "allowOverlap",
"description": "Allow overlapping time frames",
"type": "boolean",
"default": true,
"multivalued": false
},
{
"name": "map",
"description": "Mapping of a label in the input annotations to a new label. Must be formatted as IN_LABEL:OUT_LABEL (with a colon). To pass multiple mappings, use this parameter multiple times. By default, all the input labels are passed as is, including any negative labels (with default value being no remapping at all). However, when at least one label is remapped, all the other \"unset\" labels are discarded as a negative label.",
"type": "map",
"default": [
"B:bars",
"S:slate",
"I:chyron",
"N:chyron",
"Y:chyron",
"C:credits",
"R:credits",
"W:other_opening",
"L:other_opening",
"O:other_opening",
"M:other_opening",
"E:other_text",
"K:other_text",
"G:other_text",
"T:other_text",
"F:other_text"
],
"multivalued": true
},
{
"name": "pretty",
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
"type": "boolean",
"default": false,
"multivalued": false
},
{
"name": "runningTime",
"description": "The running time of the app will be recorded in the view metadata",
"type": "boolean",
"default": false,
"multivalued": false
},
{
"name": "hwFetch",
"description": "The hardware information (architecture, GPU and vRAM) will be recorded in the view metadata",
"type": "boolean",
"default": false,
"multivalued": false
}
]
}
6 changes: 6 additions & 0 deletions docs/_apps/swt-detection/v6.1/submission.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"time": "2024-07-30T01:06:00+00:00",
"submitter": "keighrim",
"image": "ghcr.io/clamsproject/app-swt-detection:v6.1",
"releasenotes": "SDK update to fix warning view bugs\n\n"
}
6 changes: 5 additions & 1 deletion docs/_data/app-index.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"http://apps.clams.ai/swt-detection": {
"description": "Detects scenes with text, like slates, chyrons and credits.",
"latest_update": "2024-07-25T16:11:42+00:00",
"latest_update": "2024-07-30T01:06:00+00:00",
"versions": [
[
"v6.1",
"keighrim"
],
[
"v6.0",
"keighrim"
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/apps.json

Large diffs are not rendered by default.

Loading