mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-06-02 19:34:40 -05:00
Renames development notebook filenames
Updates references to the development notebook naming convention from `[module].ipynb` to `[module]_dev.ipynb` in documentation. This change ensures consistency across the project and aligns with the intended naming scheme for development notebooks.
This commit is contained in:
@@ -41,7 +41,7 @@ python bin/tito.py info # Check system status
|
||||
|
||||
Each module follows this pattern:
|
||||
1. **Read overview**: `modules/[name]/README.md`
|
||||
2. **Work in notebook**: `modules/[name]/[name].ipynb`
|
||||
2. **Work in notebook**: `modules/[name]/[name]_dev.ipynb`
|
||||
3. **Export code**: `python bin/tito.py sync`
|
||||
4. **Run tests**: `python bin/tito.py test --module [name]`
|
||||
5. **Move to next module when tests pass**
|
||||
|
||||
@@ -64,7 +64,7 @@ cat README.md
|
||||
### Step 3: Open the Development Notebook
|
||||
```bash
|
||||
# Start Jupyter Lab
|
||||
jupyter lab setup.ipynb
|
||||
jupyter lab setup_dev.ipynb
|
||||
|
||||
# The notebook will open in your browser at http://localhost:8888
|
||||
```
|
||||
@@ -125,7 +125,7 @@ graph LR
|
||||
| Command | Purpose | When to Use |
|
||||
|---------|---------|-------------|
|
||||
| `cat README.md` | Read module overview | Start of each module |
|
||||
| `jupyter lab [module].ipynb` | Open development environment | Implement code |
|
||||
| `jupyter lab [module]_dev.ipynb` | Open development environment | Implement code |
|
||||
| `python bin/tito.py sync` | Export notebooks to package | After coding in notebook |
|
||||
| `python bin/tito.py test --module [name]` | Test your implementation | Verify correctness |
|
||||
| `python bin/tito.py info` | Check system status | Anytime |
|
||||
@@ -146,7 +146,7 @@ cat README.md
|
||||
|
||||
### Step 3: Start Building
|
||||
```bash
|
||||
jupyter lab tensor.ipynb
|
||||
jupyter lab tensor_dev.ipynb
|
||||
```
|
||||
|
||||
In this module, you'll implement:
|
||||
@@ -211,7 +211,7 @@ python bin/tito.py test --module setup -v
|
||||
pip install jupyter jupyterlab
|
||||
|
||||
# Try classic notebook instead
|
||||
jupyter notebook modules/setup/setup.ipynb
|
||||
jupyter notebook modules/setup/setup_dev.ipynb
|
||||
```
|
||||
|
||||
## 📚 Learning Path
|
||||
@@ -281,7 +281,7 @@ You now have everything you need to start building ML systems from scratch!
|
||||
# Quick reminder of the workflow:
|
||||
cd modules/setup/ # Navigate to module
|
||||
cat README.md # Read overview
|
||||
jupyter lab setup.ipynb # Start implementing
|
||||
jupyter lab setup_dev.ipynb # Start implementing
|
||||
# [work in notebook]
|
||||
python bin/tito.py sync # Export to package
|
||||
python bin/tito.py test --module setup # Test implementation
|
||||
|
||||
10
README.md
10
README.md
@@ -45,12 +45,12 @@ cd modules/setup/
|
||||
cat README.md
|
||||
|
||||
# Open the development notebook
|
||||
jupyter lab setup.ipynb
|
||||
jupyter lab setup_dev.ipynb
|
||||
```
|
||||
|
||||
### 3. Development Workflow
|
||||
|
||||
1. **Work in module notebooks** (`modules/[module]/[module].ipynb`)
|
||||
1. **Work in module notebooks** (`modules/[module]/[module]_dev.ipynb`)
|
||||
2. **Mark code for export** with `#| export` directives
|
||||
3. **Export to package** with `python bin/tito.py sync`
|
||||
4. **Test your code** with `python bin/tito.py test --module [module]`
|
||||
@@ -84,7 +84,7 @@ TinyTorch follows a progressive module structure. Each module builds on the prev
|
||||
| `python bin/tito.py test --module [name]` | Test specific module | Test tensor module |
|
||||
| `python bin/tito.py test --all` | Run all tests | Test everything |
|
||||
| `python bin/tito.py info` | Check implementation status | Show progress |
|
||||
| `jupyter lab [module].ipynb` | Start module development | Open tensor notebook |
|
||||
| `jupyter lab [module]_dev.ipynb` | Start module development | Open tensor notebook |
|
||||
|
||||
## 📦 Package Structure
|
||||
|
||||
@@ -132,7 +132,7 @@ cd modules/[module-name]/
|
||||
cat README.md
|
||||
|
||||
# 3. Open development notebook
|
||||
jupyter lab [module-name].ipynb
|
||||
jupyter lab [module-name]_dev.ipynb
|
||||
|
||||
# 4. Implement functions with #| export
|
||||
# 5. Test interactively in notebook
|
||||
@@ -162,7 +162,7 @@ Each module follows a consistent structure:
|
||||
```
|
||||
modules/[module-name]/
|
||||
├── README.md # 📖 Module overview and instructions
|
||||
├── [module-name].ipynb # 📓 Main development notebook
|
||||
├── [module-name]_dev.ipynb # 📓 Main development notebook
|
||||
├── test_[module].py # 🧪 Automated tests
|
||||
└── check_[module].py # ✅ Manual verification (optional)
|
||||
```
|
||||
|
||||
@@ -16,7 +16,7 @@ By the end of this module, you will:
|
||||
```
|
||||
modules/tensor/
|
||||
├── README.md # 📖 This file - Module overview
|
||||
├── tensor.ipynb # 📓 Main development notebook
|
||||
├── tensor_dev.ipynb # 📓 Main development notebook
|
||||
├── test_tensor.py # 🧪 Automated tests
|
||||
└── check_tensor.py # ✅ Manual verification (coming soon)
|
||||
```
|
||||
@@ -35,7 +35,7 @@ python bin/tito.py test --module setup # Should pass
|
||||
cd modules/tensor/
|
||||
|
||||
# Open the development notebook
|
||||
jupyter lab tensor.ipynb
|
||||
jupyter lab tensor_dev.ipynb
|
||||
```
|
||||
|
||||
### Step 3: Work Through the Implementation
|
||||
|
||||
Reference in New Issue
Block a user