Update stale recipes/quickstart paths to getting-started#1054
Update stale recipes/quickstart paths to getting-started#1054PedroooAlmeida wants to merge 1 commit into
Conversation
|
Hi @PedroooAlmeida! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
What does this PR do?
The repo refactor renamed
recipes/quickstart→getting-started(documented inUPDATES.md), but several docs still reference the old path intorchrun/sbatchcommands and link text. Users following these instructions verbatim hit a "file not found" error sincerecipes/quickstart/finetuning/finetuning.pyno longer exists at that path.This PR updates 5 docs to point to the current location at
getting-started/finetuning/. It also fixes a pre-existing typo wherefinetune_vision_model.mdreferenced a singulardatasetfolder; the actual folder isdatasets(plural). The RAFT-Chatbot README also had a separate stale path (recipes/finetuning/datasets/raft_dataset.py) which was updated in the same fix.Files changed:
getting-started/finetuning/finetune_vision_model.md(3 torchrun examples + 1 typo fix)getting-started/finetuning/multigpu_finetuning.md(sbatch path)getting-started/finetuning/datasets/README.md(link text)getting-started/inference/local_inference/README.md(torchrun example)end-to-end-use-cases/RAFT-Chatbot/README.md(two stale paths in one torchrun example)Feature/Issue validation/testing
Verified by inspecting the repo at current
main:getting-started/finetuning/finetuning.pyexists at the new pathgetting-started/finetuning/multi_node.slurmexists at the new pathgetting-started/finetuning/datasets/is the actual folder name (plural)getting-started/finetuning/datasets/raft_dataset.pyexists at the new pathrecipes/quickstart/finetuning/no longer exists in the repogit grep "recipes/quickstart/finetuning"after the change returns no results in user-facing docs (onlyUPDATES.md, which legitimately documents the rename)Before submitting