Reviewed MaxText README.md #590
Conversation
README.md
Outdated
| @@ -19,13 +19,22 @@ | |||
|
|
|||
| # Overview | |||
|
|
|||
| MaxText is a **high performance**, **highly scalable**, **open-source** LLM written in pure Python/Jax and targeting Google Cloud TPUs and GPUs for **training** and **inference**. MaxText achieves [high MFUs](#runtime-performance-results) and scales from single host to very large clusters while staying simple and "optimization-free" thanks to the power of Jax and the XLA compiler. | |||
| MaxText is a set of open source reference implementations that are | |||
There was a problem hiding this comment.
When you write, do you view your output in markdown? I don't mind your line breaks assuming they aren't showing up externally unexpectedly.
There was a problem hiding this comment.
(I did view it here and it looked good but I just want to make sure you own the Markdown nonsense: https://github.com/mikegre-google/maxtext/tree/main)
There was a problem hiding this comment.
I did view the rendered output and it looked OK, but if you usually don't put in the extra line breaks, I'm happy to remove them. Either way I will own any markdown issues.
|
I addressed the feedback and removed the extra new lines from README.md |
additional readme updates
|
I squashed my commits and pushed the changes to a new branch. I got a message saying "warning you are about to push to the main branch" and, while I'm pretty sure I can't push to this repo's main branch, I didn't want to take any chances of messing anything up since my forked repo has not been synced with this repo. Please let me know if there is anything else I need to do. Michelle Yoo told me that after I squash my commits, and my changes pass whatever testing is done, a CL will be created. but I don't know if that CL will be assigned to me or if I get notified when that happens. Sorry for the newbie questions. Once I go through this process, I won't have to ask all these questions again. Thanks for your understanding. |
additional readme updates README updates
I updated the MaxText/README.md file for clarity and for it to follow the devsite style guide (mostly).