Skip to content

Commit cb2ef64

Browse files
Merge pull request #3594 from AI-Hypercomputer:bvandermoon-uxr-fixes
PiperOrigin-RevId: 896127826
2 parents c57e4c5 + 98f8cca commit cb2ef64

4 files changed

Lines changed: 15 additions & 1 deletion

File tree

docs/guides/run_python_notebook.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ To install, click the `Extensions` icon on the left sidebar (or press `Ctrl+Shif
105105

106106
To execute post-training notebooks on your TPU-VM, follow the official [MaxText installation guides](https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source) and specifically follow `Option 3: Installing [tpu-post-train]`. This will ensure all post-training dependencies are installed inside your virtual environment.
107107

108+
> **Note:** If you have previously installed MaxText with a different option (e.g., `maxtext[tpu]`), we strongly recommend using a fresh virtual environment for `maxtext[tpu-post-train]` to avoid potential library version conflicts.
109+
108110
### Step 5: Install the necessary library for Jupyter
109111

110112
Jupyter requires a kernel to execute code. This kernel is tied to a specific Python environment. Open your terminal inside VS Code and run:
@@ -164,6 +166,8 @@ pip3 install jupyterlab
164166

165167
To execute post-training notebooks on your TPU-VM, follow the official [MaxText installation guides](https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source) and specifically follow `Option 3: Installing [tpu-post-train]`. This will ensure all post-training dependencies are installed inside your virtual environment.
166168

169+
> **Note:** If you have previously installed MaxText with a different option (e.g., `maxtext[tpu]`), we strongly recommend using a fresh virtual environment for `maxtext[tpu-post-train]` to avoid potential library version conflicts.
170+
167171
### Step 5: Register virtual environment as a Jupyter Kernel
168172

169173
Once the environment is set up, you need to register it so JupyterLab can see it as an available kernel. Run the following command on your TPU-VM, replacing <virtual env name> with the actual name to your virtual environment:

docs/install_maxtext.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ source maxtext_venv/bin/activate
3838

3939
# 3. Install MaxText and its dependencies. Choose a single
4040
# installation option from this list to fit your use case.
41+
# IMPORTANT: If you want to switch to a different installation option
42+
# (e.g., from [tpu] to [tpu-post-train]), we strongly recommend
43+
# starting with a fresh virtual environment to avoid dependency conflicts.
4144

4245
# Option 1: Installing maxtext[tpu]
4346
uv pip install maxtext[tpu]==0.2.1 --resolution=lowest
@@ -80,7 +83,10 @@ uv venv --python 3.12 --seed maxtext_venv
8083
source maxtext_venv/bin/activate
8184

8285
# 3. Install dependencies in editable mode. Choose a single
83-
# installation option from this list to fit your use case.
86+
# installation option from this list to fit your use case.
87+
# IMPORTANT: If you want to switch to a different installation option
88+
# (e.g., from [tpu] to [tpu-post-train]), we strongly recommend
89+
# starting with a fresh virtual environment to avoid dependency conflicts.
8490

8591
# Option 1: Installing .[tpu]
8692
uv pip install -e .[tpu] --resolution=lowest

docs/tutorials/posttraining/rl.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Let's get started!
4646

4747
For instructions on installing MaxText with post-training dependencies on your VM, please refer to the [official documentation](https://maxtext.readthedocs.io/en/latest/install_maxtext.html) and use the `maxtext[tpu-post-train]` installation path to include all necessary post-training dependencies.
4848

49+
> **Note:** If you have previously installed MaxText with a different option (e.g., `maxtext[tpu]`), we strongly recommend using a fresh virtual environment for `maxtext[tpu-post-train]` to avoid potential library version conflicts.
50+
4951
## Setup environment variables
5052

5153
Login to Hugging Face. Provide your access token when prompted:

docs/tutorials/posttraining/sft.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ In this tutorial we use a single host TPU VM such as `v6e-8/v5p-8`. Let's get st
2828

2929
For instructions on installing MaxText with post-training dependencies on your VM, please refer to the [official documentation](https://maxtext.readthedocs.io/en/latest/install_maxtext.html) and use the `maxtext[tpu-post-train]` installation path to include all necessary post-training dependencies.
3030

31+
> **Note:** If you have previously installed MaxText with a different option (e.g., `maxtext[tpu]`), we strongly recommend using a fresh virtual environment for `maxtext[tpu-post-train]` to avoid potential library version conflicts.
32+
3133
## Setup environment variables
3234

3335
Login to Hugging Face. Provide your access token when prompted:

0 commit comments

Comments
 (0)