|
2 | 2 |
|
3 | 3 | Bring PyTorch models to Core AI for on-device execution. |
4 | 4 |
|
5 | | -## What is Core AI? |
6 | | - |
7 | | -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. |
8 | | - |
9 | | -```{image} _images/core-ai-ecosystem.png |
10 | | -: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. |
11 | | -:align: center |
12 | | -``` |
13 | | - |
14 | | -The Core AI ecosystem consists of the following components: |
15 | | - |
16 | | -- Convert PyTorch models to the Core AI model format (`.aimodel`) using [Core AI PyTorch Extensions](https://github.com/apple/coreai-torch) |
17 | | -- Compress models with quantization, palettization, and pruning using [Core AI Optimization](https://github.com/apple/coreai-optimization) |
18 | | -- Load and run models in an app with the [Core AI Framework](https://developer.apple.com/documentation/coreai) |
19 | | -- Inspect, debug, and profile models using [Core AI Debugger](https://developer.apple.com/documentation/coreai/inspecting-debugging-and-profiling-core-ai-models) |
20 | | -- Get popular open-source models with conversion, optimization, and Swift app integration code using [Core AI Models](https://github.com/apple/coreai-models) |
21 | | - |
22 | 5 | ## Overview |
23 | 6 |
|
24 | 7 | Core AI PyTorch Extensions (`coreai-torch`) is a Python package that bridges PyTorch and Core AI. You can use it to bring up an existing PyTorch model — exported as a `torch.export.ExportedProgram` — into a Core AI `AIProgram` ready to run on Apple hardware, traversing the FX graph node-by-node and mapping ATen operators to Core AI operations. You can equally use it to author Core AI models directly from PyTorch by composing the library of composite ops in `coreai_torch.composite_ops`, authoring new ops via `register_torch_lowering`, and authoring inline Metal GPU kernels through `TorchMetalKernel` and `register_custom_kernels` — all expressed as PyTorch `nn.Module`s and lowered to Core AI IR that the compiler recognizes and optimizes natively. |
@@ -57,6 +40,23 @@ coreai_program.optimize() |
57 | 40 | - **Customizing bring-up:** {doc}`guides/conversion-workflows` covers each bring-up workflow. {doc}`guides/externalization` covers preserving submodule boundaries as composite ops. |
58 | 41 | - **API reference:** {doc}`api/TorchConverter` documents every method and parameter. {doc}`api/composite-ops` lists all built-in composite ops. {doc}`api/TorchMetalKernel` covers the Metal-kernel authoring API. |
59 | 42 |
|
| 43 | +## What is Core AI? |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +```{image} _images/core-ai-ecosystem.png |
| 48 | +: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. |
| 49 | +:align: center |
| 50 | +``` |
| 51 | + |
| 52 | +The Core AI ecosystem consists of the following components: |
| 53 | + |
| 54 | +- Convert PyTorch models to the Core AI model format (`.aimodel`) using [Core AI PyTorch Extensions](https://github.com/apple/coreai-torch) |
| 55 | +- Compress models with quantization, palettization, and pruning using [Core AI Optimization](https://github.com/apple/coreai-optimization) |
| 56 | +- Load and run models in an app with the [Core AI Framework](https://developer.apple.com/documentation/coreai) |
| 57 | +- Inspect, debug, and profile models using [Core AI Debugger](https://developer.apple.com/documentation/coreai/inspecting-debugging-and-profiling-core-ai-models) |
| 58 | +- Get popular open-source models with conversion, optimization, and Swift app integration code using [Core AI Models](https://github.com/apple/coreai-models) |
| 59 | + |
60 | 60 | ## Links |
61 | 61 |
|
62 | 62 | - [Repository](https://github.com/apple/coreai-torch) |
|
0 commit comments