Skip to content

Conversation

@NuojCheng
Copy link
Collaborator

@NuojCheng NuojCheng commented Jan 22, 2026

Description

This PR consolidates and reorganizes the example notebooks and pedagogical scripts within the repository. Specifically, it moves files from src/MaxText/examples/ and pedagogical_examples/ into a unified src/maxtext/examples/ directory. All internal references, documentation links, and CI workflows have been updated to reflect these path changes.

Key Changes

  • Directory Consolidation:
    • Moved all Jupyter notebooks (e.g., rl_llama3_demo.ipynb, sft_llama3_demo.ipynb, demo_decoding.ipynb) from src/MaxText/examples/ to src/maxtext/examples/.
    • Moved pedagogical scripts (e.g., non_spmd.py, shardings.py, shmap_collective_matmul.py) from the top-level pedagogical_examples/ directory to src/maxtext/examples/.
  • Workflow Updates: Updated .github/workflows/run_jupyter_notebooks.yml to set the new MAXTEXT_NOTEBOOKS_ROOT path and include src in PYTHONPATH.
  • Documentation & Links:
    • Updated README.md and various files in docs/ to ensure links point to the new examples directory.
    • Updated notebook metadata and internal code blocks that referenced the old paths.
  • Configuration & Tests:
    • Updated rl.yml configuration to point to the new chat_template_path.
    • Updated integration tests to import from the new location.
    • Updated codecov.yml to reflect the new directory structure for coverage ignore rules.

Tests

CI

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • 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.

@NuojCheng NuojCheng added the draft Draft PR label Jan 22, 2026
@codecov
Copy link

codecov bot commented Jan 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@khatwanimohit
Copy link
Collaborator

Great catch! :)

@NuojCheng NuojCheng changed the title PR 3000! Move examples under maxtext/examples Jan 27, 2026
@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch 8 times, most recently from 0572e3a to 34441f1 Compare January 27, 2026 23:10
@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch from 34441f1 to fdeee6d Compare January 28, 2026 00:44
@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch 2 times, most recently from 37c98f5 to 661d6df Compare January 28, 2026 23:53
@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch 3 times, most recently from 8191bd3 to 719e632 Compare January 29, 2026 03:41
@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch from 719e632 to 7a69d7c Compare January 29, 2026 20:03
@NuojCheng NuojCheng marked this pull request as ready for review January 29, 2026 20:12
Copy link
Collaborator

@khatwanimohit khatwanimohit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@NuojCheng NuojCheng force-pushed the chengnuojin-pr-3000 branch from a01dcad to 5840964 Compare January 30, 2026 19:08
@NuojCheng NuojCheng added pull ready and removed draft Draft PR labels Jan 30, 2026
@SurbhiJainUSC SurbhiJainUSC merged commit 41be8da into main Jan 31, 2026
38 of 42 checks passed
@SurbhiJainUSC SurbhiJainUSC deleted the chengnuojin-pr-3000 branch January 31, 2026 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants