Skip to content

Commit afd10ca

Browse files
committed
Updated docs
1 parent edd8551 commit afd10ca

File tree

6 files changed

+20
-5
lines changed

6 files changed

+20
-5
lines changed

Documentation/DocSource/QuickStart.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ If you've just updated the package, it is recommended to check the [*changelogs*
1111

1212
This documentation is still a WIP. This is an example script for a sustained conversational experience, tested with [gemma-3n-E2B-it-int4](https://huggingface.co/google/gemma-3n-E2B-it-litert-lm) on a Quest 3. Please refer to the reference manual for more information on each class.
1313

14+
Before running this script, push your LiteRT-LM model to your device at `/data/local/tmp/model.litertlm` using ADB, like:
15+
`adb push /Path/to/your/model.litertlm /data/local/tmp/model.litertlm`
16+
1417
```csharp
1518
using TMPro;
1619
using UnityEngine;

Documentation/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ _layout: landing
44

55
# UAI.LiteRTLM
66

7-
LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.8.0 of the LiteRT-LM Kotlin package for Android.
7+
LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.8.0+ of the LiteRT-LM Kotlin package for Android.
88

99
[![openupm](https://img.shields.io/npm/v/com.uralstech.uai.litertlm?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.uralstech.uai.litertlm/)
1010
[![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.uralstech.uai.litertlm)](https://openupm.com/packages/com.uralstech.uai.litertlm/)
@@ -32,17 +32,23 @@ here: [EDM4U - Getting Started](https://github.com/googlesamples/unity-jar-resol
3232
4. Open the Unity Package Manager window (`Window` -> `Package Manager`)
3333
5. Change the registry from `Unity` to `My Registries`
3434
6. Add the `UAI.LiteRTLM` package
35+
- Install `1.0.0-preview.1-litertlm0.9.0alpha01` (default) for litertlm-android v0.9.0-alpha01
36+
- Install `1.0.0-preview.1` for litertlm-android v0.8.0
3537

3638
# [Unity Package Manager](#tab/upm)
3739

40+
This will install the latest release of UAI.LiteRTLM. See [*releases*](https://github.com/Uralstech/UAI.LiteRTLM/releases)
41+
on which version of litertlm-android the latest release supports. If you want to use a different version of litertlm-android,
42+
please choose a different installation method.
43+
3844
1. Open the Unity Package Manager window (`Window` -> `Package Manager`)
3945
2. Select the `+` icon and `Add package from git URL...`
4046
3. Paste the UPM branch URL and press enter:
4147
- `https://github.com/Uralstech/UAI.LiteRTLM.git#upm`
4248

4349
# [GitHub Clone](#tab/github)
4450

45-
1. Clone or download the repository from the desired branch (master, preview/unstable)
51+
1. Clone or download the repository from the desired branch (master, preview/unstable) or tag (`1.0.0-preview.1` for litertlm-android v0.8.0, `1.0.0-preview.1-litertlm0.9.0alpha01` for litertlm-android v0.9.0-alpha01)
4652
2. Drag the package folder `UAI.LiteRTLM/UAI.LiteRTLM/Packages/com.uralstech.uai.litertlm` into your Unity project's `Packages` folder
4753

4854
---

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UAI.LiteRTLM
22

3-
LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.8.0 of the LiteRT-LM Kotlin package for Android.
3+
LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.8.0+ of the LiteRT-LM Kotlin package for Android.
44

55
[![openupm](https://img.shields.io/npm/v/com.uralstech.uai.litertlm?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.uralstech.uai.litertlm/)
66
[![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.uralstech.uai.litertlm)](https://openupm.com/packages/com.uralstech.uai.litertlm/)
@@ -28,17 +28,23 @@ here: [EDM4U - Getting Started](https://github.com/googlesamples/unity-jar-resol
2828
4. Open the Unity Package Manager window (`Window` -> `Package Manager`)
2929
5. Change the registry from `Unity` to `My Registries`
3030
6. Add the `UAI.LiteRTLM` package
31+
- Install `1.0.0-preview.1-litertlm0.9.0alpha01` (default) for litertlm-android v0.9.0-alpha01
32+
- Install `1.0.0-preview.1` for litertlm-android v0.8.0
3133

3234
### Unity Package Manager
3335

36+
This will install the latest release of UAI.LiteRTLM. See [*releases*](https://github.com/Uralstech/UAI.LiteRTLM/releases)
37+
on which version of litertlm-android the latest release supports. If you want to use a different version of litertlm-android,
38+
please choose a different installation method.
39+
3440
1. Open the Unity Package Manager window (`Window` -> `Package Manager`)
3541
2. Select the `+` icon and `Add package from git URL...`
3642
3. Paste the UPM branch URL and press enter:
3743
- `https://github.com/Uralstech/UAI.LiteRTLM.git#upm`
3844

3945
### GitHub Clone
4046

41-
1. Clone or download the repository from the desired branch (master, preview/unstable)
47+
1. Clone or download the repository from the desired branch (master, preview/unstable) or tag (`1.0.0-preview.1` for litertlm-android v0.8.0, `1.0.0-preview.1-litertlm0.9.0alpha01` for litertlm-android v0.9.0-alpha01)
4248
2. Drag the package folder `UAI.LiteRTLM/UAI.LiteRTLM/Packages/com.uralstech.uai.litertlm` into your Unity project's `Packages` folder
4349

4450
## Preview Versions
Binary file not shown.
Binary file not shown.

UAI.LiteRTLM/Packages/com.uralstech.uai.litertlm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "com.uralstech.uai.litertlm",
33
"displayName": "UAI.LiteRTLM",
4-
"description": "LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.8.0 of the LiteRT-LM Kotlin package for Android.",
4+
"description": "LiteRT-LM model inference support for Unity Android and Meta Quest apps. Supports v0.9.0-alpha01 of the LiteRT-LM Kotlin package for Android.",
55
"keywords": [],
66
"version": "1.0.0-preview.1-litertlm0.9.0alpha01",
77
"unity": "6000.0",

0 commit comments

Comments
 (0)