Skip to main content

C++23 Build System License Khwarzma

kh-shield

kh-shield is a high-throughput, multimodal content moderation suite written in C++23 with Python bindings. Designed from the ground up for zero-GPU execution, kh-shield performs real-time moderation across text, images, audio, and video streams while maintaining strict resource limits (optimized for 2 vCPU and 8GB RAM host environments).

The engine integrates deterministic NLP algorithms, digital signal processing (DSP), and geometric computer vision to enforce comprehensive ethical, safety, and content safety policies.


Technical Highlights

  • Zero-GPU Multimodal Processing: All visual and acoustic analysis routines execute on native CPU vector instructions (AVX2/NEON) without external GPU or deep-learning model runtime dependencies.
  • Stream-Based Buffer Allocation: Processes high-definition video and audio files in ring-buffered memory streams, bounding RAM utilization under 50MB regardless of file size.
  • Deterministic Text Moderation: Integrates Aho-Corasick exact matching, an Arabizi normalization engine, and a quantized CPU-bound SAM text model for Arabic and multilingual semantic validation.
  • Geometric Exposure & Skin Detection: Combines adaptive HSV color space thresholds, face bounding box exclusion zones, and spatial contour analysis to accurately detect explicit body exposure while preventing false positives on faces and hands.
  • Acoustic Energy & Spectral Analysis: Employs Fast Fourier Transform (FFT) and Root Mean Square (RMS) energy evaluation to detect explicit music patterns and high-BPM background audio while isolating spoken vocals.
  • OCR Bridge Layer: Extract on-screen text overlays from suspicious video frames and routes the string directly into the core text filtering pipeline.

Installation & Build

System Dependencies

  • C++23 compliant compiler (GCC 13+ or Clang 16+)
  • CMake 3.22+
  • OpenCV 4.x (C++ API, CPU modules)
  • Tesseract OCR C++ API

Build Native Engine

git clone [https://github.com/khwarzma/kh-shield.git](https://github.com/khwarzma/kh-shield.git)
cd kh-shield
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j$(nproc)

Install Python Binding

pip install .

Quickstart

Python API

import khshield

# Initialize engine with preferred policy preset
engine = khshield.ShieldEngine(preset=khshield.Preset.STRICT)

# 1. Moderating Raw Text
text_report = engine.analyze_text("نص تجريبي للترشيح المباشر")
print(f"Is Safe: {text_report.is_safe}")

# 2. Moderating Image Files
image_report = engine.analyze_image("path/to/image.jpg")
if not image_report.is_safe:
    print(f"Image Blocked. Risk Score: {image_report.risk_score}")

# 3. Moderating Video Streams (Audio + Visual + OCR)
video_report = engine.analyze_video("path/to/media.mp4")
print(f"Status: {'SAFE' if video_report.is_safe else 'BLOCKED'}")
print(f"Violation Category: {video_report.violation_type}")

Documentation Directory

Metadata

Release files for khshield 1.0.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 khshield 1.0.0
File Size Uploaded
khshield-1.0.0.tar.gz 27.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for khshield 1.0.0
File Interpreter ABI Platform
khshield-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 58.1 kB

Release files / khshield-1.0.0.tar.gz

Download URL khshield-1.0.0.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
6cc119c098d6f0d3a642d3bbdb977f60405d14f64ec8db8ffbbac9681cd9a8ac
BLAKE2b-256 checksum
How to use checksums
7884a0ac8acd3b90eb8f51bb19878eeda1cfd2e379eade4da2d509d88f1e0a81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / khshield-1.0.0-py3-none-any.whl

Download URL khshield-1.0.0-py3-none-any.whl
Size 31.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
77029ee20cf5991ce004f2fc9892291a74805f7600a386dedf0cce429cf37e0d
BLAKE2b-256 checksum
How to use checksums
fc948cb8f8c49b0686a634e7981a2e04f5ff57e7d19a7398fa425ca46a0202cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

1.0.2

1 release file

1.0.1

2 release files

This release

1.0.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