Skip to main content

Python SDK and CLI for interacting with the Dell Enterprise Hub (DEH)

Project description

Dell AI SDK and CLI

Version License Python Versions

A Python SDK and CLI for interacting with the Dell Enterprise Hub (DEH), allowing users to programmatically browse available AI models, view platform configurations, and generate deployment snippets for running AI models on Dell systems.

[!WARNING] This library is intended to be used with the Dell Enterprise Hub on Dell instances, and is subject to changes before the 0.1.0 release!

Features

  • Browse available AI models
  • View platform configurations
  • Generate deployment snippets for running AI models on Dell hardware
  • Simple and easy-to-use API
  • Consistent CLI commands

Installation

We recommend installing the package using uv, a fast Rust-based Python package and project manager, after setting up a Python virtual environment:

# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create and activate virtual environment
uv venv .venv
source .venv/bin/activate

# Install dell-ai
uv pip install dell-ai

Alternative: pip

You can also use pip to install the package:

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate

# Install dell-ai
pip install dell-ai

Installing from Source

If you want to contribute to development or need the latest changes, you can install from source:

# Clone the repository
git clone https://github.com/huggingface/dell-ai.git
cd dell-ai

# Create and activate virtual environment (using either method above)
# Then install in development mode
pip install -e .  # or uv pip install -e .

Quick Start

For detailed, guided examples of using the Dell AI SDK and CLI, check out the example documents in the examples directory:

  • examples/sdk-getting-started.ipynb: A comprehensive walkthrough of the SDK features
  • examples/cli-getting-started.md: A guide to using the CLI commands

Using the CLI

# Authenticate with Hugging Face
dell-ai login

# List available models
dell-ai models list

# Get details about a specific model
dell-ai models show meta-llama/Llama-4-Maverick-17B-128E-Instruct

# List available platform SKUs
dell-ai platforms list

# Generate a Docker deployment snippet
dell-ai models get-snippet --model-id meta-llama/Llama-4-Maverick-17B-128E-Instruct --platform-id xe9680-nvidia-h200 --engine docker --gpus 8 --replicas 1

Using the SDK

from dell_ai.client import DellAIClient

# Initialize the client (authentication happens automatically if you've logged in via CLI)
client = DellAIClient()

# List available models
models = client.list_models()
print(models)

# Get model details
model_details = client.get_model(model_id="meta-llama/Llama-4-Maverick-17B-128E-Instruct")
print(model_details.model_dump())

# List available platforms
platforms = client.list_platforms()
print(platforms)

# Get platform details
platform_details = client.get_platform(platform_id="xe9680-nvidia-h200")
print(platform_details.model_dump())

# Get deployment snippet
snippet = client.get_deployment_snippet(
    model_id="meta-llama/Llama-4-Maverick-17B-128E-Instruct",
    platform_id="xe9680-nvidia-h200",
    engine="docker",
    num_gpus=8,
    num_replicas=1
)
print(snippet)

Testing

The project uses pytest for testing. To run the tests:

# Run all tests
pytest

# Run tests with coverage report
pytest --cov=dell_ai

# Run specific test file
pytest tests/unit/test_exceptions.py

Contributing

Contributions are welcome! Please see RELEASE_PROCESS.md for information on how the release process works when contributing code changes.

When submitting a PR:

  1. Ensure all tests pass
  2. Add tests for new functionality
  3. Follow the existing code style

License

Licensed under the Apache License, Version 2.0.

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

dell_ai-0.1.5.tar.gz (212.7 kB view details)

Uploaded Source

Built Distribution

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

dell_ai-0.1.5-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

Details for the file dell_ai-0.1.5.tar.gz.

File metadata

  • Download URL: dell_ai-0.1.5.tar.gz
  • Upload date:
  • Size: 212.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dell_ai-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1b3423b35ccd0298f06538b315b9c537187bd44abd05c8f70010a52341e76e7b
MD5 3a3c2585166dcaa7710d7f6331e92eba
BLAKE2b-256 64435d8669a261fe04c10d8fe2a0975427f526e1afb62470d9f47cbf3bc11f4d

See more details on using hashes here.

File details

Details for the file dell_ai-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: dell_ai-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 39.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dell_ai-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 07e42af1d27b42ea65850e2c0414709429bc4065362651d0a6d10184c2e92958
MD5 e73a5982f4dc79523966588c7163378f
BLAKE2b-256 20c6c264523a84574c447cbe3c614c4db17834c82f773ba9830f5c36c0909677

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