Skip to content

Commit

Permalink
docs: add note how to run iOS app
Browse files Browse the repository at this point in the history
  • Loading branch information
szymonrybczak committed Jul 23, 2024
1 parent e15993b commit e87bebc
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions example/ios/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Setup

To compile the model you need to execute the following command:

```bash
mlc_llm package
```

> [!NOTE]
> To setup `mlc_llm` read the [official documentation](https://llm.mlc.ai/docs/install/mlc_llm.html#install-mlc-packages)
This will generate necessary binaries and model itself in the `build` & `dist` directories.

Then model is added to XCode project under `bundle/` directory which then is used by the module.

In the future, we will automate this process, so when the model is not found under the bundle/ directory, it will be downloaded from HuggingFace in the runtime.

0 comments on commit e87bebc

Please sign in to comment.