Installation & Setup

Prerequisites

• Python & OS Requirements: See DeGirum PySDK Documentation
• DeGirum AI Hub Account: Create an account at AI Hub and set up a workspace with the appropriate permissions to generate licenses for degirum-vehicle. See Workspace Plans for plan details and Manage AI Hub Tokens for setting up your authentication token
• Hardware Acceleration (optional): See Runtimes & Drivers for hardware-specific runtime setup

---

Setup Workflow

Follow these steps to get started with degirum-vehicle:

1. Create AI Hub Account: Sign up at AI Hub if you don't have an account
2. Set up Workspace: Create or join a workspace with the appropriate plan (see Workspace Plans)
3. Generate Token: Follow the token management guide to set up authentication
4. Install Package: Run pip install -i https://pkg.degirum.com degirum-vehicle
5. (Optional) Install Hardware Drivers: If using hardware acceleration, set up the required drivers

---

Installation

DeGirum hosts its own PyPI server for DeGirum packages.

pip install -i https://pkg.degirum.com degirum-vehicle

---

Verify Installation

Quick test to verify the package is installed correctly:

import degirum_vehicle
from degirum_tools import remote_assets

# Create LP recognizer with default configuration
lpr = degirum_vehicle.LicensePlateRecognizer(
    degirum_vehicle.LicensePlateRecognizerConfig()
)

# Process a demo image
result = lpr.predict(remote_assets.car)

# Display results
for plate in result.license_plates:
    print(f"Plate: {plate.plate_number}, OCR Score: {plate.ocr_score:.2f}")

If this runs without errors, the package is installed correctly!

Next Steps

Continue to Basic Concepts to learn about the core components of degirum-vehicle.