Skip to content

Commit 7c8d658

Browse files
Merge pull request #3967 from AI-Hypercomputer:shralex_test_7
PiperOrigin-RevId: 919451064
2 parents 7249840 + e1d0513 commit 7c8d658

2 files changed

Lines changed: 24 additions & 3 deletions

File tree

docs/build_maxtext.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ gcloud auth configure-docker
4242
docker run hello-world
4343
```
4444

45+
```{note}
46+
If the `docker run hello-world` command fails with a permission denied error (e.g., `dial unix /var/run/docker.sock: connect: permission denied`), please ensure you have correctly followed step 2 of the prerequisites to configure sudoless Docker. Running `sudo usermod -aG docker $USER` followed by starting a new shell session is usually required to apply the group permissions.
47+
```
48+
4549
## Installation Modes
4650

4751
We recommend building MaxText inside a Python virtual environment using `uv` for speed and dependency management.

docs/install_maxtext.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,23 @@ environment to avoid dependency conflicts.
149149
uv pip install -e .[runner] --resolution=lowest
150150
```
151151
152-
After installation, you can verify the package is available with
153-
`python3 -c "import maxtext"` and run training jobs with
154-
`python3 -m maxtext.trainers.pre_train.train ...`.
152+
## Verify installation
153+
154+
After installing MaxText (either from PyPI or from source), verify that your virtual environment is healthy and free of package version conflicts:
155+
156+
1. **Verify the environment has no dependency conflicts:**
157+
158+
```bash
159+
uv pip check
160+
```
161+
162+
```{note}
163+
If `uv pip check` reports any package version conflicts, they can usually be resolved by starting with a fresh virtual environment (see above) and reinstalling using the platform-specific target and the `--resolution=lowest` flag to ensure all dependencies resolve to their verified versions.
164+
```
165+
166+
2. **Verify MaxText is importable and runnable:**
167+
168+
```bash
169+
python3 -c "import maxtext"
170+
python3 -m maxtext.trainers.pre_train.train --help
171+
```

0 commit comments

Comments
 (0)