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.

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

Merged
merged 2 commits into from
Apr 14, 2024

Conversation

orionr
Copy link
Contributor

@orionr orionr commented Apr 14, 2024

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 in torchtune at https://github.com/pytorch/torchtune/blob/main/README.md

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 14, 2024
@orionr orionr force-pushed the combine-getting-started-readme branch from 4bee209 to ea41a14 Compare April 14, 2024 17:03
Copy link
Contributor

@mikekgfb mikekgfb left a 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

@orionr
Copy link
Contributor Author

orionr commented Apr 14, 2024

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.

@orionr orionr merged commit 97e23f0 into pytorch:main Apr 14, 2024
6 of 12 checks passed
@mikekgfb
Copy link
Contributor

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)

malfet pushed a commit that referenced this pull request Jul 17, 2024
…md (#176)

* Partial revamp of README.md into sections and remove GETTING-STARTED.md. Include GGUF updates from #176
malfet pushed a commit that referenced this pull request Jul 17, 2024
…md (#176)

* Partial revamp of README.md into sections and remove GETTING-STARTED.md. Include GGUF updates from #176
malfet pushed a commit that referenced this pull request Jul 17, 2024
…md (#176)

* Partial revamp of README.md into sections and remove GETTING-STARTED.md. Include GGUF updates from #176
malfet pushed a commit that referenced this pull request Jul 17, 2024
…md (#176)

* Partial revamp of README.md into sections and remove GETTING-STARTED.md. Include GGUF updates from #176
malfet pushed a commit that referenced this pull request Jul 17, 2024
…md (#176)

* Partial revamp of README.md into sections and remove GETTING-STARTED.md. Include GGUF updates from #176
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants