Skip to main content

signlang-augmenter

signlang-augmenter preview

signlang-augmenter is a Python library for sign language video augmentation.

The first shipped domain is video augmentation. The current video API exposes 44 supported augmentation keywords across 5 groups: spatial, photometric, noise/quality, temporal, and camera simulation. Pose augmentation is planned for a later phase and the pose package remains a placeholder for that future work.

What is included

  • Video I/O helpers for reading and writing clips.
  • Reproducible augmentation helpers with a shared seed function.
  • A single convenience entry point for keyword-based usage: augment_video.
  • Separate augmentation modules for spatial, photometric, noise/quality, temporal, and camera simulation transforms.
  • A public API under signlang_augmenter.video with 11 exported helpers.

Install

Option 1: Install the library to use it

pip install signlang-augmenter

Or install it directly from GitHub:

python -m pip install "git+https://github.com/24-mohamedyehia/signlang-augmenter.git"

Option 2: Install the project for development

If you want to modify the code and contribute, use an isolated environment and editable install:

  1. Install Miniconda if needed.
  2. Run:
git clone https://github.com/24-mohamedyehia/signlang-augmenter.git
cd signlang-augmenter
conda create -n signlang-augmenter python=3.11 -y
conda activate signlang-augmenter
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Quick Import Check

Use this when you want a fast sanity check that the library imports correctly and the public entry point is available:

from signlang_augmenter.video import augment_video, list_supported_video_methods

print(len(list_supported_video_methods()))
print(list_supported_video_methods())

If the import succeeds, the library is ready to use.

Example

Open examples/basic_pipeline.ipynb for a notebook that shows the video-only workflow with one convenience-wrapper example and separate examples for each augmentation group.

Typical usage:

from pathlib import Path

from signlang_augmenter.video import augment_video

input_video = Path("./data/sample.mp4")
output_dir = Path("./outputs")

outputs = augment_video(
    input_video_path=input_video,
    output_dir=output_dir,
    speed_up=1.15,
    frame_sampling=0.75,
    random_crop=0.9,
    horizontal_flip=0.3,
)

Public API

Use signlang_augmenter.video as the main entry point. It exports 11 helpers:

  • augment_video
  • list_supported_video_methods
  • set_seed
  • read_video_cv2
  • write_video_cv2
  • spatial_augmentations_to_videos
  • photometric_augmentations_to_videos
  • list_supported_photometric_methods
  • noise_quality_augmentations_to_videos
  • temporal_augmentations_to_videos
  • camera_simulation_to_videos

For the full breakdown of categories, defaults, and method counts, see docs/README.md.

Metadata

Release files for signlang-augmenter 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for signlang-augmenter 0.1.0
File Size Uploaded
signlang_augmenter-0.1.0.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for signlang-augmenter 0.1.0
File Interpreter ABI Platform
signlang_augmenter-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 29.5 kB

Release files / signlang_augmenter-0.1.0.tar.gz

Download URL signlang_augmenter-0.1.0.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
6af2f236a439eb05722b4bd0d03c60f5316aa1c9fb94c75cd5ac3da8bd53c9cc
BLAKE2b-256 checksum
How to use checksums
fb0bee9bcf0200a52b502af65d29f93df9c32bf7c2814a2d3170aa3b4badba4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / signlang_augmenter-0.1.0-py3-none-any.whl

Download URL signlang_augmenter-0.1.0-py3-none-any.whl
Size 16.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6fc234e2ac6b4b230cc16d589d1b0b2a8c2545791f9e680dc1cdc9fc1ce5a9c2
BLAKE2b-256 checksum
How to use checksums
6fe799e71f95ae411e3aa60f77793b533fa90abd01f024d17d5f1dc3f08c420d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page