From a3ed2d0a320fcb18ae412c71fa3b0813e8912d57 Mon Sep 17 00:00:00 2001 From: Vijay Janapa Reddi Date: Sun, 21 Sep 2025 15:56:08 -0400 Subject: [PATCH] Update example documentation with exciting new names MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - XORnet 🔥 - Updated header and branding - CIFAR-10 🎯 - Updated header and path references - Fixed example paths in documentation - Added emojis to make documentation more exciting Documentation now matches the new exciting directory names! --- examples/cifar10/README.md | 4 ++-- examples/xornet/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/cifar10/README.md b/examples/cifar10/README.md index 843c3150..385364e4 100644 --- a/examples/cifar10/README.md +++ b/examples/cifar10/README.md @@ -1,4 +1,4 @@ -# TinyTorch CIFAR-10 Classification Examples +# CIFAR-10 🎯 This directory demonstrates TinyTorch's capability to train real neural networks on real datasets with impressive results. Students can achieve **57.2% test accuracy** on CIFAR-10 using their own autograd implementation - performance that **exceeds typical ML course benchmarks** and approaches research-level results for MLPs! @@ -31,7 +31,7 @@ This directory demonstrates TinyTorch's capability to train real neural networks ### Run the Main Example (57.2% accuracy) ```bash -cd examples/cifar10_classifier +cd examples/cifar10 python train_cifar10_mlp.py ``` diff --git a/examples/xornet/README.md b/examples/xornet/README.md index 778c4a86..4ae21ca2 100644 --- a/examples/xornet/README.md +++ b/examples/xornet/README.md @@ -1,4 +1,4 @@ -# XOR Network Example +# XORnet 🔥 The classic XOR problem that launched the deep learning revolution!