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 …

• Version history and patch notes

• CLAMS Python API documentation

• MMIF-specific Python API documentation

• Public CLAMS App Directory

---

What’s New in 1.5.0

(Full changelog available in the CHANGELOG.md)

Overview

Adds tfSamplingMode as a universal runtime parameter and overhauls container image builds with arm64 support and split HuggingFace/transformers versioning.

Additions

• Add tfSamplingMode universal parameter for controlling frame selection from TimeFrame annotations, integrated with mmif-python’s new sampling API (https://github.com/clamsproject/clams-python/pull/278, https://github.com/clamsproject/clams-python/pull/280)

Changes

• Fix arm64 container builds and split -hf images into -hf4/-hf5 with -hf as alias to -hf5 for backward compat; dropped -tf2-hf combined images (https://github.com/clamsproject/clams-python/pull/276, https://github.com/clamsproject/clams-python/pull/281)

[!NOTE] This release requires mmif-python >= 1.3.0 for the sampling mode API.

---

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
• GPU Memory Management for CLAMS Apps
  • Overview
  • Declaring GPU Memory Requirements
  • Gunicorn Integration
  • NVIDIA Memory Oversubscription
  • Monitoring with hwFetch
• CLAMS App Metadata
  • Overview
• CLAMS App Directory
• clams shell command
• Tutorial: Wrapping an NLP Application
  • The NLP tool
  • Wrapping the tokenizer
  • Working with TimeFrame Annotations
  • Containerization with Docker

API documentation:

• clams package
  • clams.app package
  • clams.appmetadata package
  • clams.restify package
  • clams.mmif_utils package

Indices and tables

• Index

• Module Index

• Search Page