fix: add missing module init and update docs #2887
Draft
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
Adds a missing init.py file to the
utils/ckpt_scriptsdirectory and updates the documentation.Added
__init__.py:A missing
__init__.pyunder src/MaxText/utils/ckpt_scripts/ causes ModuleNotFoundError when trying to import from this package.This issue is present in the current MaxText pip wheel. Adding the init.py makes the directory a package, resolving the import error.
Documentation Updates:
The documentation has been updated to include missing explanations and command-line examples for the checkpoint conversion scripts.
Tests
To verify the fix, we performed the following tests:
Installed MaxText using
uv pip install maxtextThe import fails:
uv pip install ..The import now succeeds without error:
These tests confirm that adding the
__init__.pyfile resolves the ModuleNotFoundError.Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.