Skip to content

docs: improve lora guide and demo notebook#4277

Open
RexBearIU wants to merge 2 commits into
mainfrom
jackyf/fix-lora-demo-comments
Open

docs: improve lora guide and demo notebook#4277
RexBearIU wants to merge 2 commits into
mainfrom
jackyf/fix-lora-demo-comments

Conversation

@RexBearIU

@RexBearIU RexBearIU commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR addresses and resolves the outstanding post-merge review comments left on PR #3970.

Specifically:

  • Adds UV_TORCH_BACKEND="cpu" environment variable: Set inside the Colab setup code block in lora_llama3_demo.ipynb prior to invoking uv to ensure proper dependency resolution for CPU/TPU VM environments and avoid huge CUDA package downloads.
  • Removes redundant PyTorch installation: Cleaned up the redundant subprocess pip call to install PyTorch prior to checkpoint conversion in lora_llama3_demo.ipynb, as PyTorch is already installed via the post-training dependencies target (tpu-post-train).
  • Fixes Relative Code Links: Converted relative links pointing outside the docs/ folder (such as ../../src/maxtext/...) to absolute GitHub URLs in docs/guides/lora_model_bringup.md so that they work correctly on the ReadTheDocs built documentation.

REPORTS: #3970

Tests

  • Validated notebook JSON syntax and schema correctness using python3 -m json.tool.
  • Inspected markdown links inside lora_model_bringup.md to ensure they point to correct absolute URLs on GitHub.

Checklist

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed, including adding new documentation pages to the relevant Table of Contents (toctree directive) as explained in our documentation.

@RexBearIU RexBearIU force-pushed the jackyf/fix-lora-demo-comments branch from 107dacb to e07f6df Compare June 26, 2026 03:09
@RexBearIU RexBearIU changed the title docs: resolve leftover lora_llama3_demo.ipynb comments from PR #3970 docs: address review comments on lora bring-up guide and demo notebook Jun 26, 2026
@RexBearIU RexBearIU changed the title docs: address review comments on lora bring-up guide and demo notebook docs: improve lora guide and demo notebook Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants