Skip to main content

Install Edge Kit

Install Edge Kit with Swift Package Manager.

Requirements​

RequirementVersion
iOS17.0 or later
macOS14.0 or later
Xcode15 or later
Swift5.9 or later
HardwareApple Silicon

For iOS apps that run larger models, enable the Increased Memory Limit entitlement.

Package​

// Package.swift
dependencies: [
.package(url: "https://github.com/AtomGradient/edge-kit.git", exact: "1.0.0-rc103")
]

Developer Preview releases should be pinned exactly. Re-run your real-device validation before moving to a newer 1.0.0-rcN tag.

Public packages

The Swift package URL is HTTPS and resolves from public GitHub repositories. Confirm package resolution before treating a tag as integrated, and re-run real-device validation after every preview upgrade.

Add the umbrella product​

.target(
name: "MyApp",
dependencies: [
.product(name: "EdgeKit", package: "edge-kit")
]
)

Then import the umbrella module:

import EdgeKit

Add individual modules​

Use individual products when you want a narrower dependency surface.

.target(
name: "MyApp",
dependencies: [
.product(name: "EdgeInference", package: "edge-kit"),
.product(name: "EdgeModelKit", package: "edge-kit")
]
)

Common imports:

import EdgeInference
import EdgeModelKit
import EdgeVoice
import EdgeMesh
import EdgeData

Verify installation​

import EdgeInference

let engine = LLMEngine()
print(engine.state)

iOS entitlement​

For models larger than small preview models, add the Increased Memory Limit entitlement in the app target. Without it, iOS may terminate the process before physical memory is exhausted.