Skip to content

Commit 5228bfa

Browse files
committed
Move Apple runtime docs to new location
1 parent b918559 commit 5228bfa

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Topics in this section will help you get started with ExecuTorch.
8989
using-executorch-android
9090
using-executorch-ios
9191
using-executorch-cpp
92+
using-executorch-runtime-integration
9293
using-executorch-troubleshooting
9394

9495
.. toctree::
Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# Using ExecuTorch on Android
22

3-
Placeholder for top-level Android documentation
3+
To use from Android, ExecuTorch provides Java API bindings and Android platform integration, available as a AAR file. The ExecuTorch C++ APIs can also be used from Android native.
4+
5+
## Installation
6+
7+
TODO Instructions on downloading the pre-built AAR. Replace with Maven/Gradle package management when available.
8+
9+
### Building from Source
10+
11+
TODO Instructions on re-creating and customizing the Android AAR.
12+
13+
## Android Backends
14+
15+
TODO Describe commonly used backends, including XNN, Vulkan, and NPUs.
16+
17+
## Runtime Integration
18+
19+
TODO Code sample in Java
20+
21+
## Next Steps
22+
23+
TODO Link to Java API reference and other relevant material

docs/source/apple-runtime.md renamed to docs/source/using-executorch-ios.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Integrating and Running ExecuTorch on Apple Platforms
1+
# Using ExecuTorch on iOS
22

3-
**Author:** [Anthony Shoumikhin](https://github.com/shoumikhin)
3+
ExecuTorch supports both iOS and macOS via Objective-C, Swift, and C++. ExecuTorch also provides backends to leverage Core ML and Metal Performance Shaders (MPS) for hardware-accelerated execution on Apple platforms.
4+
5+
## Integration
46

57
The ExecuTorch Runtime for iOS and macOS is distributed as a collection of prebuilt [.xcframework](https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle) binary targets. These targets are compatible with both iOS and macOS devices and simulators and are available in both release and debug modes:
68

@@ -17,8 +19,6 @@ Link your binary with the ExecuTorch runtime and any backends or kernels used by
1719

1820
**Note:** To access logs, link against the Debug build of the ExecuTorch runtime, i.e., the `executorch_debug` framework. For optimal performance, always link against the Release version of the deliverables (those without the `_debug` suffix), which have all logging overhead removed.
1921

20-
## Integration
21-
2222
### Swift Package Manager
2323

2424
The prebuilt ExecuTorch runtime, backend, and kernels are available as a [Swift PM](https://www.swift.org/documentation/package-manager/) package.
@@ -84,9 +84,9 @@ swift package resolve
8484
swift build
8585
```
8686

87-
### Local Build
87+
### Building from Source
8888

89-
Another way to integrate the ExecuTorch runtime is to build the necessary components from sources locally and link against them. This route is more involved but certainly doable.
89+
Another way to integrate the ExecuTorch runtime is to build the necessary components from sources locally and link against them. This is useful when customizing the runtime.
9090

9191
1. Install [Xcode](https://developer.apple.com/xcode/resources/) 15+ and Command Line Tools:
9292

@@ -195,7 +195,7 @@ import ExecuTorch
195195

196196
### Logging
197197

198-
We provide extra APIs for logging in Objective-C and Swift as a lightweight wrapper of the internal ExecuTorch machinery. To use it, just import the main framework header in Objective-C. Then use the `ExecuTorchLog` interface (or the `Log` class in Swift) to subscribe your own implementation of the `ExecuTorchLogSink` protocol (or `LogSink` in Swift) to listen to log events.
198+
ExecuTorch provides extra APIs for logging in Objective-C and Swift as a lightweight wrapper of the internal ExecuTorch machinery. To use it, just import the main framework header in Objective-C. Then use the `ExecuTorchLog` interface (or the `Log` class in Swift) to subscribe your own implementation of the `ExecuTorchLogSink` protocol (or `LogSink` in Swift) to listen to log events.
199199

200200
```objectivec
201201
#import <ExecuTorch/ExecuTorch.h>

0 commit comments

Comments
 (0)