-
Notifications
You must be signed in to change notification settings - Fork 229
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.
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
[Usability] Break README.md into sections and remove GETTING-STARTED.md #176
Conversation
4bee209
to
ea41a14
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Let's make sure we don't lose content.
Please also pull in content from https://github.com/pytorch/torchat/pull/170/commits which has updated for GGUF file loading and status that was not yet landed in the README.md
Yup - didn't remove any content for now, although I think we'll ned to trim it down later. Are the test failures any concern @mikekgfb ? Looks unrelated. |
Test failures are always a concern! The biggest issue right now is the segmentation fault that happens reproducibly. Possibly the dso we build is broken because the rest is Python which should not have unsafe references. Will need help from compiler team as discussed (the incorrect results from AOTI are another item) |
Did some significant reordering and revamp on README.md and removed GETTING-STARTED.md. We still need to support flags like
--help
, but this gets us much closer to install expectations and also matches a bit more to best practices as you'll see intorchtune
at https://github.com/pytorch/torchtune/blob/main/README.md