Welcome to CLAMS Python SDK documentation!

CLAMS project

CLAMS project aims at free and open-source software platform for computational analysis and metadata generation applications for multimedia material. We believe free and open AI-based multimedia processing platform can bring many benefits of technical advancement to libraries, archives, and museums. To achieve interoperability between various computational applications developed be different vendors, which is absolutely necessary for using applications together supported by user-friendly workflow engines, we are also developing JSON-based MultiMedia Interchange Format (MMIF)

clams-python

clams-python is a Python implementation of the CLAMS SDK. clams-python provides CLAMS app developers with the following assistance ;

1. handling MMIF files for input and output specification for CLAMS apps

2. a base Python class to start developing a CLAMS app

3. a flask-based wrapper to run a Python CLAMS app as an HTTP web app

4. cookie-cutter shell command that sets up everything and starts a new CLAMS app project

Start now from Getting Started!

For more …

For user manuals and Python API documentation, take a look at Python modules.

For MMIF-specific Python API documentation, take a look at the mmif-python website.

Contents

• Getting started
  • Overview
  • Prerequisites
  • Installation
  • Quick Start with the App Template
• I/O Specification
  • mmif package
  • MMIF version and CLAMS apps
• Runtime Configuration
  • As Python API
  • As HTTP Server
• CLAMS App Metadata
  • Overview
  • Format
  • Metadata Schema
• CLAMS App Directory
• clams shell command
• Tutorial: Wrapping an NLP Application
  • The NLP tool
  • Wrapping the tokenizer
  • Containerization with Docker

API documentation:

• clams package
  • clams.restify package
  • clams.app package
  • clams.source package
  • clams.appmetadata package

Indices and tables

• Index

• Module Index

• Search Page