Skip to main content

Safety-critical cognitive safety library for AI agents

Project description

llmosafe Python Bindings

Safety-critical cognitive safety library for AI agents.

Installation

From PyPI (recommended)

pip install llmosafe

From source

# Install maturin (build tool)
pip install maturin

# Build and install
cd python
maturin develop --release

# Or build wheel
maturin build --release
pip install dist/llmosafe-*.whl

Quick Start

from llmosafe import calculate_halo, check_resources, get_stability

# Check for cognitive bias in text
text = "The expert recommendation is proven and certified."
bias_score = calculate_halo(text)
print(f"Bias score: {bias_score}")  # Higher = more bias detected

# Check resource limits
try:
    check_resources(1024)  # 1GB ceiling
    print("Resources OK")
except llmosafe.ResourceExhaustedError:
    print("Memory limit exceeded!")

# Check cognitive stability
stability = get_stability(synapse_bits=400)
if stability == 0:
    print("Cognitive state stable")
else:
    print(f"Instability detected: {stability}")

API Reference

Bias Detection

calculate_halo(text: str) -> int

Calculate the "halo signal" (bias score) for text. Detects:

  • Authority bias (expert, official, certified)
  • Social proof (popular, trending, consensus)
  • Scarcity (limited, exclusive, rare)
  • Urgency (now, fast, deadline)
  • Emotional appeal (love, fear, miracle)
  • Expertise signaling (sophisticated, cutting-edge)

Returns: Bias score (0 = no bias, higher = more bias patterns detected)

Resource Management

check_resources(ceiling_mb: int) -> int

Check if current memory usage is within ceiling.

Returns: 0 if OK, raises ResourceExhaustedError if exceeded.

get_resource_pressure(ceiling_mb: int) -> int

Get current memory pressure as percentage (0-100).

Stability Checking

get_stability(synapse_bits: int) -> int

Check if cognitive state (synapse) is stable.

Returns: 0 if stable, -2 if cognitive instability, -3 if bias halo detected.

System Metrics

get_system_cpu_load() -> int

Get current CPU load percentage (0-100).

get_environmental_entropy() -> int

Get environmental entropy score (0-1000, higher = more entropy).

Advanced

process_synapse(synapse_bits: int) -> int

Process a cognitive state update through the full safety pipeline.

Returns: 0 if successful, negative error code otherwise.

Exceptions

All exceptions inherit from llmosafe.LLMOSafeError:

  • ResourceExhaustedError: Memory ceiling exceeded
  • CognitiveInstabilityError: Cognitive entropy threshold exceeded
  • BiasHaloDetectedError: Bias pattern detected in input

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest llmosafe/tests -v

# Type checking
mypy llmosafe

# Build wheel
maturin build --release

License

MIT License - see LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llmosafe-0.6.0-cp312-cp312-manylinux_2_34_x86_64.whl (288.6 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

File details

Details for the file llmosafe-0.6.0-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for llmosafe-0.6.0-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 fcadf5a69588bf0976e7232efca6821d495c9a67628c31ce2d0495a0d75b0f49
MD5 01bb5899846d6ce62abb7ece50fad26e
BLAKE2b-256 ae1a8ead2fbd9c6520a1715b25cf3ab714ffb08b27419d5ac0921163756d5aef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page