Skip to content

Commit 349197a

Browse files
committed
Address review comments
1 parent 842f3ff commit 349197a

2 files changed

Lines changed: 27 additions & 30 deletions

File tree

docs/development/contribute_docs.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,17 @@ If you are writing documentation for MaxText, you may want to preview the
2626
documentation site locally to ensure things work as expected before a deployment
2727
to [Read The Docs](https://readthedocs.org/).
2828

29-
First, make sure you [install MaxText from source](install-from-source) and
30-
install the necessary dependencies. You can do this by navigating to your local
31-
clone of the MaxText repo and running:
29+
First, make sure you
30+
[install MaxText from source](https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source)
31+
and install the necessary dependencies. You can do this by navigating to your
32+
local clone of the MaxText repo and running:
3233

3334
```bash
3435
uv pip install -r src/dependencies/requirements/requirements_docs.txt
3536
```
3637

37-
Once the dependencies are installed and your `maxtext_venv` virtual environment is activated, you can navigate to the `docs/` folder and run:
38+
Once the dependencies are installed and your `maxtext_venv` virtual environment
39+
is activated, you can navigate to the `docs/` folder and run:
3840

3941
```bash
4042
sphinx-build -b html . _build/html
@@ -61,6 +63,7 @@ toctree.
6163

6264
## Documentation deployment
6365

64-
The MaxText documentation is deployed to
65-
[https://maxtext.readthedocs.io](https://maxtext.readthedocs.io) on any
66-
successful merge to the main branch.
66+
The latest version of the MaxText documentation, tracking the main branch of
67+
development, is automatically deployed to
68+
[https://maxtext.readthedocs.io/en/latest](https://maxtext.readthedocs.io/en/latest)
69+
on any successful merge to the main branch.

docs/install_maxtext.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
This document discusses how to install MaxText.
2020

2121
We recommend installing MaxText inside a Python virtual environment and using
22-
the [uv package manager](https://docs.astral.sh/uv/getting-started/installation/).
22+
the `uv` package manager following
23+
[uv's official installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
2324

2425
```{note}
2526
MaxText is only tested on Linux during releases.
@@ -29,25 +30,16 @@ MaxText is only tested on Linux during releases.
2930

3031
This is the easiest way to get started with the latest stable version.
3132

32-
1. **Clone the repository:**
33+
1. **Create a virtual environment:**
3334

3435
```bash
35-
git clone https://github.com/AI-Hypercomputer/maxtext.git
36-
cd maxtext
36+
uv venv --python 3.12 --seed <virtual env name>
37+
source <virtual env name>/bin/activate
3738
```
3839

39-
2. **Create a virtual environment:**
40-
41-
```bash
42-
uv venv --python 3.12 --seed maxtext_venv
43-
source maxtext_venv/bin/activate
44-
```
40+
2. **Install MaxText and its dependencies.**
4541

46-
3. **Install MaxText and its dependencies.**
47-
48-
Choose a single installation option from this list to fit your use case. For
49-
each installation option, a different helper script is necessary to complete
50-
the installation of required dependencies that are not yet available on PyPI.
42+
Choose a single installation option from this list to fit your use case.
5143

5244
```{important}
5345
If you want to switch to a different installation option (e.g., from `[tpu]`
@@ -60,30 +52,30 @@ This is the easiest way to get started with the latest stable version.
6052

6153
```bash
6254
uv pip install maxtext[tpu]==0.2.1 --resolution=lowest
63-
install_tpu_pre_train_extra_deps
6455
```
6556

6657
- **Option 2:** Install `maxtext[cuda12]`, used for pre-training and decoding
6758
on GPUs.
6859

6960
```bash
7061
uv pip install maxtext[cuda12]==0.2.1 --resolution=lowest
71-
install_cuda12_pre_train_extra_deps
7262
```
7363

7464
- **Option 3:** Install `maxtext[tpu-post-train]`, used for post-training on
75-
TPUs. Currently, this option should also be used for running `vllm_decode` on TPUs.
65+
TPUs. Currently, this option should also be used for running `vllm_decode`
66+
on TPUs.
7667

7768
```bash
7869
uv pip install maxtext[tpu-post-train]==0.2.1 --resolution=lowest
79-
install_tpu_post_train_extra_deps
8070
```
8171

8272
- **Option 4:** Install `maxtext[runner]`, used for building MaxText's Docker
8373
images and scheduling workloads through XPK. Once installed, you will have
8474
access to the `build_maxtext_docker_image`, `upload_maxtext_docker_image`,
8575
and `xpk` commands. For more details on building and uploading Docker
86-
images, see the [Build MaxText Docker Image](https://maxtext.readthedocs.io/en/latest/build_maxtext.html) guide.
76+
images, see the
77+
[Build MaxText Docker Image](https://maxtext.readthedocs.io/en/latest/build_maxtext.html)
78+
guide.
8779
8880
```bash
8981
uv pip install maxtext[runner]==0.2.1 --resolution=lowest
@@ -123,8 +115,8 @@ environment to avoid dependency conflicts.
123115
2. Create virtual environment:
124116
125117
```bash
126-
uv venv --python 3.12 --seed maxtext_venv
127-
source maxtext_venv/bin/activate
118+
uv venv --python 3.12 --seed <virtual env name>
119+
source <virtual env name>/bin/activate
128120
```
129121
130122
3. Install dependencies in editable mode. Choose a single installation option
@@ -157,4 +149,6 @@ environment to avoid dependency conflicts.
157149
uv pip install -e .[runner] --resolution=lowest
158150
```
159151
160-
After installation, you can verify the package is available with `python3 -c "import maxtext"` and run training jobs with `python3 -m maxtext.trainers.pre_train.train ...`.
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 ...`.

0 commit comments

Comments
 (0)