Skip to main content

Secure Python sandbox for AI/ML code execution using Docker. Run LLM outputs safely.

Project description

AICodeSandbox

AICodeSandbox is a Python library designed to provide a secure and isolated environment for executing AI and machine learning code, particularly for Language Models (LLMs). It leverages Docker containers to create sandboxes, enabling safe execution of potentially untrusted AI-generated code.

Features

  • Create isolated Python environments using Docker containers
  • Securely run AI-generated code or LLM outputs
  • Install custom Python packages in the sandbox
  • Execute Python code safely within the sandbox
  • Read and write files within the sandbox environment
  • Automatically clean up resources after use

Key Advantages

  • Security: Isolates AI-generated code execution, protecting your system from potentially harmful operations.
  • Speed: Optimized container creation and management for quick sandbox setup and execution.
  • Customization: Easily add specific Python packages or use custom Docker images to suit your AI and ML needs.
  • Resource Control: Limit CPU and memory usage to prevent resource abuse.
  • Flexibility: Run various types of AI models and code snippets without worrying about system integrity.
  • Easy Clean-up: Automatic resource management ensures no leftover containers or images.

Requirements

To run AICodeSandbox, you need:

  • Python 3.7+
  • Docker installed and running on your system
  • docker Python package
  • Sufficient permissions to create and manage Docker containers
  • Internet connection (for initial package downloads)

Installation

  1. Clone this repository:

    git clone https://github.com/typper-io/ai-code-sandbox.git
    cd ai-code-sandbox
    
  2. Install the required Python packages:

    pip install -r requirements.txt
    

Usage

Here's a basic example of how to use AICodeSandbox:

from ai_code_sandbox import AICodeSandbox

# Create a sandbox with common AI/ML packages
sandbox = AICodeSandbox(packages=["numpy", "pandas", "scikit-learn", "tensorflow"])

try:
    # Run some AI-generated code in the sandbox
    code = """
    import numpy as np
    import pandas as pd
    from sklearn.model_selection import train_test_split
    from tensorflow.keras.models import Sequential
    from tensorflow.keras.layers import Dense

    # Generate some dummy data
    X = np.random.rand(1000, 10)
    y = np.random.randint(0, 2, 1000)

    # Split the data
    X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2)

    # Create a simple neural network
    model = Sequential([
        Dense(64, activation='relu', input_shape=(10,)),
        Dense(32, activation='relu'),
        Dense(1, activation='sigmoid')
    ])

    model.compile(optimizer='adam', loss='binary_crossentropy', metrics=['accuracy'])

    # Train the model
    history = model.fit(X_train, y_train, epochs=10, validation_split=0.2, verbose=0)

    # Evaluate the model
    loss, accuracy = model.evaluate(X_test, y_test, verbose=0)
    print(f"Test accuracy: {accuracy:.4f}")
    """
    result = sandbox.run_code(code)
    print(result)

finally:
    # Always close the sandbox to clean up resources
    sandbox.close()

Running in Docker

You can also run AICodeSandbox inside a Docker container. This setup uses Docker-in-Docker (DinD) to allow the AICodeSandbox to create and manage Docker containers from within a Docker container.

Example Dockerfile:

FROM docker:dind

RUN apk add --no-cache python3 py3-pip

WORKDIR /app

COPY requirements.txt .
COPY README.md .
COPY ai_code_sandbox/ ./ai_code_sandbox/
COPY setup.py .

RUN python3 -m venv /app/venv
ENV PATH="/app/venv/bin:$PATH"

RUN pip3 install --upgrade pip
RUN pip3 install -r requirements.txt
RUN pip3 install -e .

COPY example.py .

CMD ["python3", "example.py"]

The docker compose docker-compose.yml:

version: '3.8'

services:
  ai_sandbox:
    build: .
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    privileged: true
    environment:
      - DOCKER_TLS_CERTDIR=""

API Reference

AICodeSandbox(custom_image=None, packages=None)

Create a new sandbox environment.

  • custom_image (optional): Name of a custom Docker image to use.
  • packages (optional): List of Python packages to install in the sandbox.
  • network_mode (optional): Network mode to use for the sandbox. Defaults to "none".
  • mem_limit (optional): Memory limit for the sandbox. Defaults to "100m".
  • cpu_period (optional): CPU period for the sandbox. Defaults to 100000.
  • cpu_quota (optional): CPU quota for the sandbox. Defaults to 50000.

sandbox.run_code(code, env_vars=None)

Execute Python code in the sandbox.

  • code: String containing Python code to execute.
  • env_vars (optional): Dictionary of environment variables to set for the execution.

sandbox.write_file(content, filename)

Write content to a file in the sandbox.

  • content: String content to write to the file.
  • filename: Name of the file to create or overwrite.

sandbox.read_file(filename)

Read content from a file in the sandbox.

  • filename: Name of the file to read.

sandbox.close()

Remove all resources created by the sandbox.

Security Considerations

While AICodeSandbox provides a secure environment for running AI-generated code, it's important to note that no sandbox solution is completely foolproof. Users should still exercise caution and implement additional security measures when dealing with potentially malicious or untrusted AI-generated code.

Contributing

Contributions to AICodeSandbox are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distribution

ai_code_sandbox-0.2.0.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file ai_code_sandbox-0.2.0.tar.gz.

File metadata

  • Download URL: ai_code_sandbox-0.2.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ai_code_sandbox-0.2.0.tar.gz
Algorithm Hash digest
SHA256 82cf935cbdc5b82a2a686c4d75321ae1f8e3083659bab7276fae4afc76076793
MD5 5b9d8e704aad4361aee3845e9aa5de43
BLAKE2b-256 e3295f60e02b6d2ef0143db5ee4a291c8cec11fb6d05a4a0ac58e8c07637b723

See more details on using hashes here.

Supported by

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