From 04b2c3fdeeea3890113e1e96350bf88a69326934 Mon Sep 17 00:00:00 2001 From: Vijay Janapa Reddi Date: Sun, 21 Dec 2025 18:33:41 -0500 Subject: [PATCH] docs: use code block for module status check command --- tinytorch/milestones/01_1957_perceptron/ABOUT.md | 6 +++++- tinytorch/milestones/02_1969_xor/ABOUT.md | 6 +++++- tinytorch/milestones/03_1986_mlp/ABOUT.md | 6 +++++- tinytorch/milestones/04_1998_cnn/ABOUT.md | 6 +++++- tinytorch/milestones/05_2017_transformer/ABOUT.md | 6 +++++- tinytorch/milestones/06_2018_mlperf/ABOUT.md | 6 +++++- 6 files changed, 30 insertions(+), 6 deletions(-) diff --git a/tinytorch/milestones/01_1957_perceptron/ABOUT.md b/tinytorch/milestones/01_1957_perceptron/ABOUT.md index eac4de9a9..cb7f69a3f 100644 --- a/tinytorch/milestones/01_1957_perceptron/ABOUT.md +++ b/tinytorch/milestones/01_1957_perceptron/ABOUT.md @@ -36,7 +36,11 @@ Input (features) --> Linear --> Sigmoid --> Output (0 or 1) ## Running the Milestone -Ensure Modules 01-04 are completed for Part 1, and Modules 01-08 for Part 2. Check with `tito module status`. +Before running, ensure you have completed the prerequisite modules. Part 1 requires Modules 01-04, Part 2 requires Modules 01-08. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/01_1957_perceptron diff --git a/tinytorch/milestones/02_1969_xor/ABOUT.md b/tinytorch/milestones/02_1969_xor/ABOUT.md index f39de9d34..a80356f09 100644 --- a/tinytorch/milestones/02_1969_xor/ABOUT.md +++ b/tinytorch/milestones/02_1969_xor/ABOUT.md @@ -53,7 +53,11 @@ These 4 points **cannot** be separated by a single line. No amount of training c ## Running the Milestone -Ensure Modules 01-08 are completed. Check with `tito module status`. +Before running, ensure you have completed Modules 01-08. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/02_1969_xor diff --git a/tinytorch/milestones/03_1986_mlp/ABOUT.md b/tinytorch/milestones/03_1986_mlp/ABOUT.md index bab02a484..0ed05890d 100644 --- a/tinytorch/milestones/03_1986_mlp/ABOUT.md +++ b/tinytorch/milestones/03_1986_mlp/ABOUT.md @@ -36,7 +36,11 @@ Images --> Flatten --> Linear --> ReLU --> Linear --> ReLU --> Linear --> Classe ## Running the Milestone -Ensure Modules 01-08 are completed. Check with `tito module status`. +Before running, ensure you have completed Modules 01-08. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/03_1986_mlp diff --git a/tinytorch/milestones/04_1998_cnn/ABOUT.md b/tinytorch/milestones/04_1998_cnn/ABOUT.md index 1b717b4af..a838867e2 100644 --- a/tinytorch/milestones/04_1998_cnn/ABOUT.md +++ b/tinytorch/milestones/04_1998_cnn/ABOUT.md @@ -33,7 +33,11 @@ Images --> Conv --> ReLU --> Pool --> Conv --> ReLU --> Pool --> Flatten --> Lin ## Running the Milestone -Ensure Modules 01-09 are completed. Check with `tito module status`. +Before running, ensure you have completed Modules 01-09. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/04_1998_cnn diff --git a/tinytorch/milestones/05_2017_transformer/ABOUT.md b/tinytorch/milestones/05_2017_transformer/ABOUT.md index 87bc1e4d7..b33f11ccb 100644 --- a/tinytorch/milestones/05_2017_transformer/ABOUT.md +++ b/tinytorch/milestones/05_2017_transformer/ABOUT.md @@ -39,7 +39,11 @@ Tokens --> Embeddings --> [Attention --> FFN] x N --> Output ## Running the Milestone -Ensure Modules 01-13 are completed. Check with `tito module status`. +Before running, ensure you have completed Modules 01-13. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/05_2017_transformer diff --git a/tinytorch/milestones/06_2018_mlperf/ABOUT.md b/tinytorch/milestones/06_2018_mlperf/ABOUT.md index 12293ded9..a81b03c62 100644 --- a/tinytorch/milestones/06_2018_mlperf/ABOUT.md +++ b/tinytorch/milestones/06_2018_mlperf/ABOUT.md @@ -37,7 +37,11 @@ Measure --> Optimize --> Validate --> Repeat ## Running the Milestone -Ensure Modules 01-18 are completed. Check with `tito module status`. +Before running, ensure you have completed Modules 01-18. You can check your progress: + +```bash +tito module status +``` ```bash cd milestones/06_2018_mlperf