Skip to content

Add docs/tutorials index and move materials tutorial into it - #15

Merged
balajiadarsha merged 1 commit into
mainfrom
docs/tutorials-by-application
Oct 22, 2026
Merged

balajiadarsha merged 1 commit into
mainfrom
docs/tutorials-by-application

Conversation

@Sande33p

@Sande33p Sande33p commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Adds docs/tutorials/, one place to find PRISM's end-to-end tutorials, grouped
by application area. Markdown pages go in docs/tutorials/<area>/, where
<area> is the application's directory under applications/, or the name it
would take for an application with no scripts there yet. Notebooks stay in
applications/<area>/, next to the scripts they run, and the index links to
them there.

  • docs/materials_prism_tutorial.md (docs: add materials PRISM training tutorial #6) moves to
    docs/tutorials/material_science/materials_prism_tutorial.md. Its relative
    link to the materials guide is updated for the new depth.
  • docs/tutorials/README.md lists each tutorial with its modalities and
    platform, links the BioReason notebook (bioreason-demo: PRISM-BioReason KEGG demo (SFT, GRPO, eval, notebook) #4) where it lives in
    applications/bioreason/, and says where a new tutorial goes.
  • docs/index.md gains a Tutorials section. README, the docs/ layout table in
    CONTRIBUTING, and CHANGELOG point to the new folder.

Three tutorials still in flight are built on this branch. Each has this commit
merged in, plus a commit that moves its pages into the new layout and adds its
rows to the two index tables:

Branch PR Pages move to
astroprism-implementation #12 docs/tutorials/astroprism/
sww/vlm-demo-docs #3 docs/tutorials/vision_language/
scits-demo not opened yet docs/tutorials/timeseries/, with the notebook in applications/timeseries/

Please merge with "Create a merge commit", not squash or rebase. The three
branches above contain this branch's commit through a merge. A merge commit
keeps that commit in main's history, so each of them still merges cleanly on
top of it. Squash and rebase both land a copy with a new SHA, and then all three
conflict with main in docs/index.md and docs/tutorials/README.md. Both
outcomes were simulated with git merge-tree against each branch.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that changes existing behavior)
  • Documentation update
  • Infrastructure, CI, or tooling

Compatibility

  • src.* import paths
  • the prism CLI surface
  • Hydra config keys
  • checkpoint keys
  • launcher flags
  • None of the above

One URL moves: docs/materials_prism_tutorial.md becomes
docs/tutorials/material_science/materials_prism_tutorial.md. Nothing in the
repository links to the old path; links to it from outside will break.

How Has This Been Tested?

tools/ci/check_doc_links.py     469 relative links resolve (459 on main)
tools/ci/check_site_paths.py    OK: 74 allowlisted files, 237 site paths, none new
pytest -q -m "not integration and not network and not slow and not gpu and not aurora and not perlmutter" tests
                                1609 passed, 2 failed, 2 skipped
pytest -q -m "not network" tests/multimodal/test_modality_contracts.py
                                21 passed
pytest -q tests/test_launch_aurora_web_vla.py tests/platform/test_perlmutter_launch_contract.py
          tests/platform/test_hpc_bridge_contract.py tests/platform/test_launcher_secrets_policy.py
                                20 passed
git merge-tree, this branch with each branch in the table above   clean

The two pytest failures fail the same way on main in the same environment and
pass in main's CI: test_every_tracked_python_file_is_visible_to_ruff and
test_intern_s2_input_preset_requires_its_encoder_implementation.

  • Platform tested on: Aurora login node, frameworks/2026.1.0, Python 3.12.
  • Tests skipped, and why: mypy and the CI-pinned ruff 0.16.9, because this PR
    changes only Markdown. CI runs both.

New Dependencies, Data, or Assets

None.

Checklist

  • I have performed a self-review of my own changes
  • The code follows the project's style guidelines
  • I have commented my code where the intent is not obvious
  • I have made corresponding changes to the documentation
  • I have added tests that cover this change, or explained why none are needed
  • New and existing tests pass locally
  • No secrets, credentials, or absolute institutional paths are included
    (see SECURITY.md)

No new tests: the change is Markdown only, and the required doc_links job
already checks every link this PR adds or moves. The two local test failures
above fail the same way on main.

AI/LLM Assistance

  • AI/LLM tools were primarily used to generate code or artifacts in this PR
  • I have reviewed all such output line-by-line and understand it

Unticked pending a human read.

Additional Context

sww/vlm-demo-docs and scits-demo both add rows after the materials row in
docs/index.md and docs/tutorials/README.md, so whichever of them merges
second will conflict there. Keep both sets of rows, time series before vision
language, so both tables stay in alphabetical order by area.

🤖 Generated with Claude Code

Group end-to-end tutorials by application area: Markdown pages in
docs/tutorials/<area>/, notebooks next to their scripts in
applications/<area>/. Move the materials tutorial to
docs/tutorials/material_science/ and fix its relative link, list it
and the BioReason notebook in the new index and in docs/index.md, and
add docs/tutorials/ to README, CONTRIBUTING and CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Sande33p
Sande33p requested a review from a team as a code owner October 22, 2026 06:32

@balajiadarsha balajiadarsha left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The changes are limited to the documents and do not add, remove or modify functionality.

@balajiadarsha
balajiadarsha merged commit 5b042cd into main Oct 22, 2026
9 checks passed
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.

2 participants