[Android] Update README for instructions #789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchchat/789
Note: Links to docs will display an error until the docs builds have been completed. ❌ 2 New Failures, 1 PendingAs of commit 269f755 with merge base 9bd4f5c ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
kirklandsign
commented
May 13, 2024
byjlw
reviewed
May 15, 2024
| [executorch-llama.aar](https://ossci-android.s3.us-west-1.amazonaws.com/executorch/release/0.2/executorch-llama.aar) (SHASUM: 09d17f7bc59589b581e45bb49511d19196d0297d) | ||
|
|
||
| ``` | ||
| curl https://ossci-android.s3.us-west-1.amazonaws.com/executorch/release/0.2/executorch-llama.aar -o android/Torchchat/app/libs/executorch.aar |
There was a problem hiding this comment.
command should include the --create-dirs otherwise it will fail to a brand new user
|
|
||
|  | ||
| The torchchat app skeleton is located at `android/Torchchat`. Use Android Studio to open this directory. |
There was a problem hiding this comment.
if the .aar file doesn't exist before you open the project and download it later, users will not be able to run. Users should run the curl command before opening the project.
| echo "09d17f7bc59589b581e45bb49511d19196d0297d android/Torchchat/app/libs/executorch.aar" | shasum --check | ||
| ``` | ||
|
|
||
| Then, click the Play button (^R) to launch it to emulator/device. |
There was a problem hiding this comment.
the app crashes right away in the simulator. Re-opening the app crashes again
There was a problem hiding this comment.
Do you have the crash log?
| Alternatively, you can run `scripts/android_example.sh` which sets up Java, Android SDK Manager, Android SDK, Android emulator, builds the app, and launches it for you. | ||
|
|
||
| ``` | ||
| export TORCHCHAT_ROOT=$(pwd) |
There was a problem hiding this comment.
command fails for me
Android sdkmanager is set up
- return
- setup_android_sdk
- sdkmanager 'platforms;android-34'
scripts/android_example.sh: line 79: sdkmanager: command not found
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* [Android] Update README for instructions * Update download instruction
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Android instructions on the readme page need to be atomic and have everything the user needs right there on the page (no external links should be required).
It should follow a similar flow as the iOS here.
https://github.com/pytorch/torchchat/blob/documentation-cleanup/README.md