Sync README project-structure tree with on-disk layout#82
Open
lonexreb wants to merge 3 commits intoNVlabs:mainfrom
Open
Sync README project-structure tree with on-disk layout#82lonexreb wants to merge 3 commits intoNVlabs:mainfrom
lonexreb wants to merge 3 commits intoNVlabs:mainfrom
Conversation
The Project Structure section had drifted from the on-disk layout: - ``notebook/`` should be ``notebooks/`` (the directory is plural; the documented path doesn't exist). - ``notebooks/inspect_dataset.ipynb`` was missing. - ``scripts/`` (containing ``download_pai.py``) and ``docs/`` (containing ``FINETUNE_SFT.md``) were not represented at all. - The ``src/alpamayo_r1/`` subtree only listed 4 of the 11 subpackages — ``chat_template``, ``common``, ``data``, ``metrics``, ``processor``, ``utils``, and ``visualization`` were omitted. - ``CONTRIBUTING.md`` and ``LICENSE`` were missing from the top level. Update the tree to match what newcomers actually see when they clone the repo, and tighten the per-package one-line descriptions. Signed-off-by: lonexreb <[email protected]>
The Interactive notebook subsection pointed at `notebook/inference.ipynb` (singular). The actual path is `notebooks/inference.ipynb` — copy-pasting the documented path into `jupyter notebook` fails. Same root cause as the project-structure tree fix in this PR. Signed-off-by: lonexreb <[email protected]>
scripts/ contains four user-facing scripts referenced from FINETUNE_SFT.md and finetune/rl/README.md. Listing only download_pai.py was incomplete. Signed-off-by: lonexreb <[email protected]>
lonexreb
force-pushed
the
docs/sync-readme-project-structure
branch
from
b3162a6 to
75b03f0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README's Project Structure section had drifted from what's actually in the repo. As a newcomer reading the README I expected a 1:1 map and found:
This PR updates the tree to match `ls` and adds a one-line description for each previously undocumented subpackage. No code changes, no behavioral changes — pure docs sync.
Verification
```console
$ ls src/alpamayo_r1/ | grep -v pycache
init.py action_space/ chat_template/ common/ config.py data/
diffusion/ geometry/ helper.py load_physical_aiavdataset.py metrics/
models/ processor/ test_inference.py utils/ visualization/
```
The new tree lists all of the above (plus the 11 subpackages) and matches what a newly-cloned working tree shows.
Test plan