Add basic documentation pages #988
Open
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
melissawm
requested review from
gobbleturk,
jonb377,
khatwanimohit,
bvandermoon and
vipannalla
as code owners
Also fixes capitalization in the checkpointing document.
shivajid
reviewed
Oct 31, 2024
|
|
||
| ## In-depth documentation | ||
|
|
||
| You can find in-depth documentation at [the MaxText GitHub repository](https://github.com/AI-Hypercomputer/maxtext/blob/main/docs/advanced_docs/). |
There was a problem hiding this comment.
Yes, these links (all that refer to docs/advanced_docs) will become true once this reorganization of the documentation is merged.
| @@ -0,0 +1,84 @@ | |||
| # Full Finetuninhg LLama2/LLama3 Optimized configuration | |||
|
|
|||
| In the pre-training section you saw the steps on how to do pre-training with | |||
There was a problem hiding this comment.
Need to rewrite this as we do not have the pre-training section missing.
|
|
||
| [^1]: Tf.data is the most performant way of loading large scale datasets. | ||
|
|
||
| You can read more about the pipelines in [Data Input Pipeline](https://github.com/AI-Hypercompute/maxtext/blob/main/docs/advanced_docs/Data_Input_Pipeline.md). |
There was a problem hiding this comment.
The link seems broken - https://github.com/AI-Hypercomputer/maxtext/blob/main/getting_started/Data_Input_Pipeline.md
There was a problem hiding this comment.
Same as above, this will be fixed once the PR is merged.
melissawm
commented
Oct 31, 2024
melissawm
commented
Oct 31, 2024
melissawm
commented
Oct 31, 2024
Comment on lines
+3
to
+5
| In the pre-training section you saw the steps on how to do pre-training with | ||
| MaxText. To perform full fine tuning, you need to pass the checkpoint to the | ||
| training script. |
There was a problem hiding this comment.
@shivajid how about:
Suggested change
| In the pre-training section you saw the steps on how to do pre-training with | |
| MaxText. To perform full fine tuning, you need to pass the checkpoint to the | |
| training script. | |
| MaxText can perform pre-training and full finetuning. To perform full fine tuning, you need to pass the checkpoint to the training script. |
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.
Adds an initial set up of documentation pages for MaxText, including a
.readthedocs.yamlfile. The project will need to be set up on the ReadTheDocs admin interface separately by the maintainers.