|
1 | 1 | # Core AI Optimization Documentation |
2 | 2 |
|
3 | | -## What is Core AI? |
4 | | - |
5 | | -Core AI is a set of technologies for deploying machine learning models on Apple hardware, covering the full model deployment lifecycle: from model optimization and conversion, to debugging, to app integration. Models run entirely on device on Apple silicon, with no server required. |
6 | | - |
7 | | -```{image} _images/core-ai-ecosystem.png |
8 | | -:alt: Diagram of the Core AI ecosystem. At the top, Core AI Models provides ready-to-use models and examples. Core AI Optimization and Core AI PyTorch Extensions prepare models for deployment, producing a .aimodel file. Core AI Debugger and Xcode support integration and debugging. Core AI Framework runs models on device. |
9 | | -:align: center |
10 | | -``` |
11 | | - |
12 | | -The Core AI ecosystem consists of the following components: |
13 | | - |
14 | | -- Convert PyTorch models to the Core AI model format (`.aimodel`) using [Core AI PyTorch Extensions](https://github.com/apple/coreai-torch) |
15 | | -- Compress models with quantization, palettization, and pruning using [Core AI Optimization](https://github.com/apple/coreai-optimization) |
16 | | -- Load and run models in an app with the [Core AI Framework](https://developer.apple.com/documentation/coreai) |
17 | | -- Inspect, debug, and profile models using [Core AI Debugger](https://developer.apple.com/documentation/coreai/inspecting-debugging-and-profiling-core-ai-models) |
18 | | -- Get popular open-source models with conversion, optimization, and Swift app integration code using [Core AI Models](https://github.com/apple/coreai-models) |
19 | | - |
20 | 3 | ## What is `coreai-opt`? |
21 | 4 |
|
22 | 5 | `coreai-opt` is a Python library for compressing PyTorch models for deployment on Apple Silicon. It allows you to apply compression-based optimizations (such as quantization or palettization) to any PyTorch model, producing a transformed PyTorch model that can be converted to a Core AI model and run with the [Core AI](https://developer.apple.com/documentation/coreai) framework. |
@@ -71,8 +54,19 @@ For an overview of the generic structure of `coreai-opt` APIs, see [How to use c |
71 | 54 |
|
72 | 55 | For end-to-end examples on API usage and common workflows, see [MNIST examples](examples/toy_models.md) and [model examples](examples/model_examples.md). |
73 | 56 |
|
74 | | -## Links to related Core AI components |
| 57 | +## What is Core AI? |
| 58 | + |
| 59 | +Core AI is a set of technologies for deploying machine learning models on Apple hardware, covering the full model deployment lifecycle: from model optimization and conversion, to debugging, to app integration. Models run entirely on device on Apple silicon, with no server required. |
| 60 | + |
| 61 | +```{image} _images/core-ai-ecosystem.png |
| 62 | +:alt: Diagram of the Core AI ecosystem. At the top, Core AI Models provides ready-to-use models and examples. Core AI Optimization and Core AI PyTorch Extensions prepare models for deployment, producing a .aimodel file. Core AI Debugger and Xcode support integration and debugging. Core AI Framework runs models on device. |
| 63 | +:align: center |
| 64 | +``` |
| 65 | + |
| 66 | +The Core AI ecosystem consists of the following components: |
75 | 67 |
|
76 | | -- **[coreai-torch](https://github.com/apple/coreai-torch)** — Python library for converting PyTorch models to the Core AI (`.aimodel`) format. |
77 | | -- **[coreai-models](https://github.com/apple/coreai-models)** — GitHub repository with example models demonstrating how to convert, optimize, and re-author models for deployment with Core AI. Several of the LLMs in there are compressed to ~4–5 bits using `coreai-opt`. The repo also contains a number of AI skills, including some that wrap `coreai-opt` workflows. |
78 | | -- **[Core AI framework](https://developer.apple.com/documentation/coreai)** — Apple's on-device AI framework that runs `.aimodel` models. |
| 68 | +- Convert PyTorch models to the Core AI model format (`.aimodel`) using [Core AI PyTorch Extensions](https://github.com/apple/coreai-torch) |
| 69 | +- Compress models with quantization, palettization, and pruning using [Core AI Optimization](https://github.com/apple/coreai-optimization) |
| 70 | +- Load and run models in an app with the [Core AI Framework](https://developer.apple.com/documentation/coreai) |
| 71 | +- Inspect, debug, and profile models using [Core AI Debugger](https://developer.apple.com/documentation/coreai/inspecting-debugging-and-profiling-core-ai-models) |
| 72 | +- Get popular open-source models with conversion, optimization, and Swift app integration code using [Core AI Models](https://github.com/apple/coreai-models) |
0 commit comments