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 - easyocr-wrapper.v1.0 #114

Closed
wants to merge 1 commit into from
Closed
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
44 changes: 44 additions & 0 deletions docs/_apps/easyocr-wrapper/v1.0/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: single
classes: wide
title: "Easyocr Wrapper (v1.0)"
---
* Submitter: [snewman-aa](https://github.com/snewman-aa)
* Submission Time: 2024-01-18T19:36:37+00:00
* Prebuilt Container Image: [ghcr.io/clamsproject/app-easyocr-wrapper:v1.0](https://github.com/clamsproject/app-easyocr-wrapper/pkgs/container/app-easyocr-wrapper/v1.0)


### Easyocr Wrapper (v1.0) [metadata.json](metadata.json)
###### Using EasyOCR to extract text from timeframes

* App ID: [http://apps.clams.ai/easyocr-wrapper/v1.0](http://apps.clams.ai/easyocr-wrapper/v1.0)
* App License: MIT
* Source Repository: [https://github.com/clamsproject/app-easyocr-wrapper](https://github.com/clamsproject/app-easyocr-wrapper) ([source tree of the submitted version](https://github.com/clamsproject/app-easyocr-wrapper/tree/v1.0))
* Analyzer Version: 1.7.0
* Analyzer License: Apache 2.0


#### Inputs
* [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1) (required)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the app also requires TimeFrame annotations as well (https://github.com/clamsproject/app-easyocr-wrapper/blob/v1.0/app.py#L41) . Metadata is missing.

###### ANY


#### Configurable Parameters
###### Multivalued parameters can have two or more values.

|Name|Description|Type|Multivalued|Default|Choices|
|----|-----------|----|-----------|-------|-------|
|sampleFrames|Number of frames to sample from timeframe|integer|N|1||
|pretty|The JSON body of the HTTP response will be re-formatted with 2-space indentation|boolean|N|false|**_`false`_**, `true`|


#### Outputs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the app.py code, and it also says the view from this app also contains Relation (https://github.com/clamsproject/app-easyocr-wrapper/blob/v1.0/app.py#L37), but never adds such annotations. Could you review the view.new_contain part of the app.py?

###### Note that not all output annotations are always generated.
* [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1)
###### ANY
* [http://mmif.clams.ai/vocabulary/Alignment/v1](http://mmif.clams.ai/vocabulary/Alignment/v1)
###### ANY
* [http://mmif.clams.ai/vocabulary/BoundingBox/v1](http://mmif.clams.ai/vocabulary/BoundingBox/v1)
###### ANY
* [http://mmif.clams.ai/vocabulary/TimePoint/v1](http://mmif.clams.ai/vocabulary/TimePoint/v1)
###### ANY
47 changes: 47 additions & 0 deletions docs/_apps/easyocr-wrapper/v1.0/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"name": "Easyocr Wrapper",
"description": "Using EasyOCR to extract text from timeframes",
"app_version": "v1.0",
"mmif_version": "1.0.0",
"analyzer_version": "1.7.0",
"app_license": "MIT",
"analyzer_license": "Apache 2.0",
"identifier": "http://apps.clams.ai/easyocr-wrapper/v1.0",
"url": "https://github.com/clamsproject/app-easyocr-wrapper",
"input": [
{
"@type": "http://mmif.clams.ai/vocabulary/VideoDocument/v1",
"required": true
}
],
"output": [
{
"@type": "http://mmif.clams.ai/vocabulary/TextDocument/v1"
},
{
"@type": "http://mmif.clams.ai/vocabulary/Alignment/v1"
},
{
"@type": "http://mmif.clams.ai/vocabulary/BoundingBox/v1"
},
{
"@type": "http://mmif.clams.ai/vocabulary/TimePoint/v1"
}
],
"parameters": [
{
"name": "sampleFrames",
"description": "Number of frames to sample from timeframe",
"type": "integer",
"default": 1,
"multivalued": false
},
{
"name": "pretty",
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
"type": "boolean",
"default": 0,
"multivalued": false
}
]
}
5 changes: 5 additions & 0 deletions docs/_apps/easyocr-wrapper/v1.0/submission.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"time": "2024-01-18T19:36:37+00:00",
"submitter": "snewman-aa",
"image": "ghcr.io/clamsproject/app-easyocr-wrapper:v1.0"
}
3 changes: 3 additions & 0 deletions docs/_data/app-index.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,8 @@
"http://apps.clams.ai/swt-detection": [
"v1.0",
"v2.0"
],
"http://apps.clams.ai/easyocr-wrapper": [
"v1.0"
]
}
2 changes: 1 addition & 1 deletion docs/_data/apps.json

Large diffs are not rendered by default.

Loading