Refactor and Fix the Readme #563
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
facebook-github-bot
added
the
CLA Signed
mikekgfb
approved these changes
Apr 29, 2024
Update README.md
mikekgfb
reviewed
Apr 30, 2024
README.md
Outdated
| @@ -161,11 +161,11 @@ This will download the ExecuTorch repo to ./et-build/src and install various Exe | |||
| ``` | |||
| export TORCHCHAT_ROOT=${PWD} | |||
| export ENABLE_ET_PYBIND=true | |||
| ./scripts/install_et.sh $ENABLE_ET_PYBIND | |||
| ./scripts/install_et.sh --pybind | |||
There was a problem hiding this comment.
Supposedly we don't need an option here, we have a PR from @metascroy
README.md
Outdated
| @@ -63,51 +85,19 @@ with `python3 torchchat.py remove llama3`. | |||
| * **Access to model is restricted and you are not in the authorized list. Visit \[link\] to ask for access**: | |||
| Some models require an additional step to access. Follow the link to fill out the request form on HuggingFace. | |||
|
|
|||
| ## What can you do with torchchat? | |||
There was a problem hiding this comment.
The installation instructions do not work. x-ref: #557
…rchchat into documentation-cleanup
Fix pathing issues for runner commands
orionr
reviewed
May 3, 2024
README.md
Outdated
| @@ -89,7 +83,12 @@ View available models with: | |||
| python3 torchchat.py list | |||
| ``` | |||
|
|
|||
| You can also remove downloaded models with the remove command: `python3 torchchat.py remove llama3` | |||
There was a problem hiding this comment.
Nit on this one is that I'd actually like them not to run it, so actually better to have inline?
There was a problem hiding this comment.
+1
Yes, I commented the same and edited the command in the README.md, togther with many others. And no, I don't deal with branches. Just submit your stuffrather than having it in a side branch and just let it drop from heaven, like a pino in a cartoon.
orionr
reviewed
May 3, 2024
README.md
Outdated
| NOTE: We use `--quantize config/data/cuda.json` to quantize the llama3 model to reduce model size and improve performance for on-device use cases. | ||
| python3 torchchat.py generate llama3 --dso-path exportedModels/llama3.so --prompt "Hello my name is" | ||
| ``` | ||
| NOTE: If you're machine has cuda add this flag for performance `--quantize config/data/cuda.json` |
There was a problem hiding this comment.
Also: "you're machine" => "your machine"
orionr
reviewed
May 3, 2024
README.md
Outdated
| @@ -126,16 +125,17 @@ Enter some text in the input box, then hit the enter key or click the “SEND” | |||
| ### AOTI (AOT Inductor) | |||
| AOT compiles models before execution for faster inference | |||
|
|
|||
| The following example exports and executes the Llama3 8B Instruct model | |||
| The following example exports and executes the Llama3 8B Instruct model. (The first command performs the actual export, the second command loads the exported model into the Python interface to enable users to test the exported model.) | |||
There was a problem hiding this comment.
No need to add parenthesis on that second sentence?
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
malfet
pushed a commit
that referenced
this pull request
Jul 17, 2024
* refactoring the readme * continued refining * more cleanup * more cleanup * more cleanup * more cleanup * more cleanup * more refining * Update README.md Update README.md * move the discaimer down * remove torchtune from main readme Fix pathing issues for runner commands * don't use pybindings for et setup --------- Co-authored-by: Michael Gschwind <[email protected]>
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.
Readme updated to match the new structure and feedback from Soumith
Sections should be more atomic meaning a user can go straight to the mobile section not get stuck even if they didn't read from start to finish.