Skip to content

Commit 091ebd1

Browse files
committed
Update setup and Readme
1 parent 31fad7a commit 091ebd1

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

backends/apple/coreml/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,18 @@ Core ML is an optimized framework for running machine learning models on Apple d
77
## Layout
88
- `compiler/` : Lowers a module to Core ML backend.
99
- `partition/`: Partitions a module fully or partially to Core ML backend.
10-
- `quantizer/`: Quantizes a module in Core ML favored scheme
10+
- `quantizer/`: Quantizes a module in Core ML favored scheme.
1111
- `scripts/` : Scripts for installing dependencies and running tests.
1212
- `runtime/`: Core ML delegate runtime implementation.
1313
- `inmemoryfs`: InMemory filesystem implementation used to serialize/de-serialize AOT blob.
1414
- `kvstore`: Persistent Key-Value store implementation.
1515
- `delegate`: Runtime implementation.
1616
- `include` : Public headers.
17-
- `tests` : Tests for Core ML delegate.
18-
- `workspace` : Xcode workspace for tests.
17+
- `sdk` : SDK implementation.
18+
- `tests` : Unit tests.
19+
- `workspace` : Xcode workspace for the runtime.
1920
- `third-party/`: External dependencies.
2021

21-
## Help & Improvements
22-
If you have problems or questions or have suggestions for ways to make
23-
implementation and testing better, please create an issue on [github](https://www.github.com/pytorch/executorch/issues).
24-
2522
## Partition and Delegation
2623

2724
To delegate a Program to the **Core ML** backend, the client must call `to_backend` with the **CoreMLPartitioner**.
@@ -122,6 +119,10 @@ The `converted_graph` is the quantized torch model, and can be delegated to **Co
122119

123120
## Runtime
124121

125-
To execute a **Core ML** delegated **Program**, the client must link to the `coremldelegate` library. Once linked there are no additional steps required, **ExecuTorch** when running the **Program** would call the **Core ML** runtime to execute the **Core ML** delegated part of the **Program**.
122+
To execute a Core ML delegated program, the application must link to the `coremldelegate` library. Once linked there are no additional steps required, ExecuTorch when running the program would call the Core ML runtime to execute the Core ML delegated part of the program.
126123

127124
Please follow the instructions described in the [Core ML setup](/backends/apple/coreml/setup.md) to link the `coremldelegate` library.
125+
126+
## Help & Improvements
127+
If you have problems or questions or have suggestions for ways to make
128+
implementation and testing better, please create an issue on [github](https://www.github.com/pytorch/executorch/issues).

backends/apple/coreml/setup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ delegated_program_manager = edge_program_manager.to_backend(CoreMLPartitioner())
4646
xcode-select --install
4747
```
4848

49-
2. Build **Core ML** delegate. The following will create a `executorch.xcframework` in `cmake-out` directory.
49+
4. Build **Core ML** delegate. The following will create `executorch.xcframework` and `coreml_backend.xcframework` in the `cmake-out` directory.
5050

5151
```bash
5252
cd executorch
5353
./build/build_apple_frameworks.sh --Release --coreml
5454
```
55-
3. Open the project in Xcode, and drag the `executorch.xcframework` generated from Step 2 to Frameworks.
55+
5. Open the project in Xcode, and drag `executorch.xcframework` and `coreml_backend.xcframework` frameworks generated from Step 2 to Frameworks.
5656

57-
4. Go to project Target’s Build Phases - Link Binaries With Libraries, click the + sign, and add the following frameworks:
57+
6. Go to project Target’s Build Phases - Link Binaries With Libraries, click the + sign, and add the following frameworks:
5858

5959
```
6060
executorch.xcframework
@@ -63,9 +63,9 @@ coreml_backend.xcframework
6363

6464
5. Go to project Target’s Build Phases - Link Binaries With Libraries, click the + sign, and add the following frameworks.
6565
```
66-
- Accelerate.framework
67-
- CoreML.framework
68-
- libsqlite3.tbd
66+
Accelerate.framework
67+
CoreML.framework
68+
libsqlite3.tbd
6969
```
7070

7171
6. The target could now run a **Core ML** delegated **Program**.

0 commit comments

Comments
 (0)