Docs streamline fixes#2838
Closed
RobMulla wants to merge 5 commits intoAI-Hypercomputer:mainfrom
Closed
Conversation
| cd ~/MaxText | ||
| ``` | ||
|
|
||
| 4. Within the root directory of the cloned repo, install dependencies and pre-commit hook by running: |
Collaborator
There was a problem hiding this comment.
These are the outdated instructions to install MaxText. Can you update this and refer to https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source?
|
This PR has been automatically marked as stale because it has not had recent activity. It will be closed soon if no further activity occurs. Thank you for your contributions. |
|
This PR was closed because it has been inactive for a while. Please reopen it if you are still working on it. |
This file contains hidden or 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
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.
Description
Title
Docs: Streamline "First Run" tutorial and "Tutorials" landing page
Description
Improves the "Day 0" experience by making the tutorials landing page more useful and the "First Run" tutorial copy-paste friendly.
Changes
tutorials.md): Added a "New to MaxText?" section and descriptions for tutorial categories.first_run.md):export BUCKET_NAMEto simplify copy-pasting.gcloudcommands for bucket creation.configs/base.ymlsnippet to show default model params (1B, float32).cd MaxText) and checkpoint usage for decoding.Motivation
Smooths out friction points for new users - preventing common errors like
FileNotFoundError(missingcd) or correct bucket permissions.Verification
sphinx-build).Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.