Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved README instructions for building in Termux on Android devices #2840

Closed
wants to merge 18 commits into from
Closed

Improved README instructions for building in Termux on Android devices #2840

wants to merge 18 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Aug 27, 2023 •
edited by ghost
Loading

Added direction to build with make, simplified OpenBlas, and CLBlast installation method. Clarified where to move models in Termux. llama.cpp is diverse, so I added a main Usage example for new users.

These instructions should work for any Android device capable of running llama.cpp.

JackJollimore added 3 commits August 27, 2023 14:44
Improve README.md for building in Termux on Android devices
364d684 
Added direction to build with `make`, and simplified `OpenBlas` method. These instructions should work for any Android device capable of running `llama.cpp`.

Clarified on where to _move_ the models in Termux. `llama.cpp` is diverse, so I added a Usage example for new users.

I left `CLBlast` instructions unchanged for now.
clarified wording
cd7b3ed
clean up Usage example
83df548 
made Usage example more clear in the case Users build with cmake
@ghost ghost changed the title Improve README.md for building in Termux on Android devices Improved README instructions for building in Termux on Android devices Aug 27, 2023
dummy-proof directions
ee55b1e 
$HOME before make is unneccesary.

If User is new with Termux then typing cd storage/downloads before $HOME is confusing.

clarified directions.
@cebtenzzre
Copy link
Collaborator

What is $HOME meant to do? My Termux has the bash shell so running it as a command would just print an error.

@ghost
Copy link
Author

ghost commented Aug 27, 2023 •
edited by ghost
Loading

What is $HOME meant to do? My Termux has the bash shell so running it as a command would just print an error.

Thanks for pointing that out. I expected $HOME to navigate to /data/data/com.termux/files/home in Termux.

I replaced $HOME for cd as it has the same effect.

$HOME is the executables directory in Termux. llama.cpp is significantly slower when loading a model from the downloads folder, for example.

corrected navigation
e69b7b5 
$HOME is a script within fish shell, assuming User uses bash then we use `cd` to navigate to /data/data/com.termux/files/home
@staviq
Copy link
Collaborator

staviq commented Aug 28, 2023 •
edited
Loading

If I remember correctly, android "sandboxes" apps such that native home folder is the app folder, and I checked with termux, not sure about other apps, but standard unix ~ works in termux, and resolves to /data/data/com.termux/files/home

Edit: I saw the diff, and I now know what you meant, but I agree $HOME is a bit confusing, so I would just say "termux app directory ( which is automatically mapped to home directory )" or something like that.

Clarify move model directions
8cb4ee0 
remove reference to Termux `$HOME` path.
@ghost
Copy link
Author

ghost commented Aug 28, 2023 •
edited by ghost
Loading

I would just say "termux app directory ( which is automatically mapped to home directory )" or something like that.

I removed $HOME because my intention is to make sure the User moves the model to the correct spot.

Thank you.

@cebtenzzre
Copy link
Collaborator

I removed $HOME because my intention is to make sure the User moves the model to the correct spot.

I think it would be sufficient to say "to the home directory (~/)". The example doesn't use its full path, and the user shouldn't have to know or care what the absolute path technically is.

JackJollimore added 2 commits August 28, 2023 00:17
crystal-clear move path destination
0a7ef3a 
User needs to move the model to the correct location, and doesn't need to know/care about the absolute path in Termux
typo fixed
8e00404
JackJollimore added 3 commits August 30, 2023 21:53
Update Usage Example
2612b36 
original example was generic, adjusted --prompt to fit alpaca-style
Update README.md
82700d8 
typo fixed
Made Usage example more easy to copy
32bbb55 
also looks better, and consistent
@ghost
Copy link
Author

ghost commented Aug 31, 2023 •
edited by ghost
Loading

@cebtenzzre Are there any other inconsistencies, or changes neccesary here?

@cebtenzzre
Copy link
Collaborator

Are there any other inconsistencies, or changes neccesary here?

Have you seen my review comments?

@ghost
Copy link
Author

ghost commented Aug 31, 2023 •
edited by ghost
Loading

Have you seen my review comments?

Hmm, I don't see a review comment, other than a couple days ago: #2840 (comment) - I implemented the change here: 0a7ef3a

I don't know where it is.

@cebtenzzre
Copy link
Collaborator

cebtenzzre commented Aug 31, 2023 •
edited
Loading

Hmm, I don't see a review comment

Do you see them here?

edit: oops, looks like I made comments but forgot to submit the review.

@ghost
Copy link
Author

ghost commented Aug 31, 2023 •
edited by ghost
Loading

Do you see them here?

I see now, let me check it out. Thank you.

cebtenzzre
cebtenzzre reviewed Aug 31, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
JackJollimore added 5 commits August 31, 2023 20:52
adjust OpenBlas from cmake to make
245a02e
Clean/Update Android ClBlast section
5a3dc43 
Replaced outdated, ineffecient steps for a streamlined method.
typo fix
673f424
easily copy/paste export
d719f6c 
made export better for copy/pasting, looks better
stylized OpenBlas text
736ff7c 
now is correctly matched with `CLBlast` & `llama.cpp`
@ghost
Copy link
Author

ghost commented Sep 1, 2023 •
edited by ghost
Loading

regarding CLBlast, a Note from current master: (some Android devices, like the Zenfone 8, need the following command instead - "export LD_LIBRARY_PATH=/system/vendor/lib64:$LD_LIBRARY_PATH".), then it links to reddit.

Certain devices export from LD_LIBRARY_PATH=/vendor/, others export from LD_LIBRARY_PATH=/system/, so I think it makes sense to note the alternative for compatibility purposes.

JackJollimore added 2 commits September 1, 2023 02:19
Ensure device compatibility for CLBlast
b47ee69 
Some devices path from Vendor, others path from System
fix typo
759dcdc
@ghost ghost closed this by deleting the head repository Sep 6, 2023
@cebtenzzre cebtenzzre mentioned this pull request Nov 4, 2023
Closed
@cebtenzzre cebtenzzre mentioned this pull request Mar 14, 2024
Merged
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cebtenzzre @staviq @ggerganov