Skip to content

Fix config resolution for pip installed maxtext #3356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Mar 10, 2026
Merged

Fix config resolution for pip installed maxtext #3356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/maxtext/configs/pyconfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ def resolve_config_path(param: str) -> str:
lowercase_param = param.replace("MaxText", "maxtext")
if os.path.isfile(lowercase_param):
return lowercase_param
# For pip-installed packages, strip the src prefix and resolve against
# the installed configs directory (MAXTEXT_CONFIGS_DIR).
if param.startswith("src/maxtext/configs/"):
candidate = os.path.join(MAXTEXT_CONFIGS_DIR, param[len("src/maxtext/configs/"):])
if os.path.isfile(candidate):
return candidate
return os.path.join("src", param)


Expand Down
4 changes: 2 additions & 2 deletions src/maxtext/trainers/post_train/rl/train_rl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
Usage Examples:

# GRPO on Llama3.1-8B-Instruct
python3 -m src.maxtext.trainers.post_train.rl.train_rl src/maxtext/configs/post_train/rl.yml \
python3 -m maxtext.trainers.post_train.rl.train_rl src/maxtext/configs/post_train/rl.yml \
model_name=llama3.1-8b \
tokenizer_path=meta-llama/Llama-3.1-8B-Instruct \
load_parameters_path=gs://path/to/checkpoint/0/items \
Expand All @@ -32,7 +32,7 @@
hf_access_token=${HF_TOKEN?}

# GSPO on Llama3.1-70B-Instruct
python3 -m src.maxtext.trainers.post_train.rl.train_rl src/maxtext/configs/post_train/rl.yml \
python3 -m maxtext.trainers.post_train.rl.train_rl src/maxtext/configs/post_train/rl.yml \
model_name=llama3.1-70b \
tokenizer_path=meta-llama/Llama-3.1-70B-Instruct \
load_parameters_path=gs://path/to/checkpoint/0/items \
Expand Down
18 changes: 16 additions & 2 deletions tests/unit/pyconfig_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@

"""Tests for pyconfig."""

import unittest
import os.path
import tempfile
import unittest

from maxtext.configs import pyconfig
from maxtext.configs.pyconfig import resolve_config_path
from maxtext.utils.globals import MAXTEXT_PKG_DIR
from maxtext.utils.globals import MAXTEXT_CONFIGS_DIR, MAXTEXT_PKG_DIR
from tests.utils.test_helpers import get_test_config_path, get_post_train_test_config_path


Expand Down Expand Up @@ -101,6 +102,19 @@ def test_resolve_config_path(self):
self.assertEqual(resolve_config_path("foo"), os.path.join("src", "foo"))
self.assertEqual(resolve_config_path(__file__), __file__)

def test_resolve_config_path_pip_install(self):
"""Simulates pip-installed env where cwd has no src/ folder."""
orig = os.getcwd()
with tempfile.TemporaryDirectory() as tmpdir:
try:
os.chdir(tmpdir)
result = resolve_config_path("src/maxtext/configs/base.yml")
self.assertEqual(result, os.path.join(MAXTEXT_CONFIGS_DIR, "base.yml"))
result = resolve_config_path("src/maxtext/configs/post_train/rl.yml")
self.assertEqual(result, os.path.join(MAXTEXT_CONFIGS_DIR, "post_train/rl.yml"))
finally:
os.chdir(orig)


if __name__ == "__main__":
unittest.main()
Loading