Skip to content

Commit c51960c

Browse files
authored
Revise README for clarity and formatting
1 parent c62939b commit c51960c

File tree

1 file changed

+55
-4
lines changed

1 file changed

+55
-4
lines changed

README.md

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,55 @@
1-
DeepLab: CNN Workbench 🧠DeepLab is an interactive educational tool designed to demystify the "black box" of Convolutional Neural Networks (CNNs). It allows students, researchers, and AI enthusiasts to visualize exactly how mathematical operations transform images into feature maps.🌟 Key FeaturesInteractive Input Layer: Draw digits/shapes on a 14x14 grid or upload your own images (automatically resized and grayscaled).Real-Time Convolution: Visualizes the "sliding window" operation with customizable kernels (Edge Detection, Sharpen, Emboss, etc.).Mathematical Transparency: Hover over any pixel in the output to see the exact equation: (Input × Weight) + Bias = Output.Dynamic Parameters: Experiment with Kernel Size (3x3, 5x5), Stride, Padding, and Activation Functions (ReLU, Sigmoid, Tanh).Animation Mode: Watch the scanner move step-by-step to understand the spatial relationship between input and output.🚀 Live DemoTry the tool directly in your browser:https://simonnchong.github.io/convolution_visualization_tool/🛠️ Tech StackFramework: ReactBuild Tool: ViteStyling: Tailwind CSSIcons: Lucide ReactDeployment: GitHub Pages (via GitHub Actions)💻 Running LocallyIf you want to run this on your own machine:Clone the repo:git clone [https://github.com/simonnchong/convolution_visualization_tool.git](https://github.com/simonnchong/convolution_visualization_tool.git)
2-
Install dependencies:npm install
3-
Start the server:npm run dev
4-
📄 LicenseThis project is open source and available under the MIT License.
1+
# DeepLab: CNN Workbench 🧠
2+
3+
[](https://www.google.com/search?q=https://simonnchong.github.io/convolution_visualization_tool/)
4+
[](https://opensource.org/licenses/MIT)
5+
6+
**DeepLab** is an interactive educational tool designed to demystify the **Convolutional Neural Network (CNN)**. It provides a hands-on environment for students and AI enthusiasts to visualize exactly how mathematical operations transform raw images into abstract **feature maps**.
7+
8+
## 🌟 Key Features
9+
10+
* **Interactive Input Layer:** Draw digits or shapes directly on a **14x14 pixel grid** or upload your own image.
11+
* **Real-Time Convolution:** Visualizes the entire pipeline with customizable parameters:
12+
* **Kernels:** Experiment with Edge Detection, Sharpen, and Emboss filters.
13+
* **Activation Functions:** Observe the effects of **ReLU**, Sigmoid, and Tanh activation on feature values.
14+
* **Mathematical Transparency:**
15+
* **Microscope Mode:** Hover over any pixel in the output feature map to reveal the **exact calculation** (`Input × Weight + Bias`) that created that single value.
16+
* **Animation Mode:** Watch the kernel physically slide across the input grid step-by-step to understand the convolution process.
17+
* **Dynamic Parameters:** Adjust **Kernel Size** (3x3, 5x5) and **Stride** to see how dimensionality changes instantly.
18+
19+
## 🚀 Live Demo
20+
21+
Try the tool directly in your browser:
22+
**[https://simonnchong.github.io/convolution\_visualization\_tool/](https://www.google.com/search?q=https://simonnchong.github.io/convolution_visualization_tool/)**
23+
24+
## 🛠️ Tech Stack
25+
26+
* **Framework:** React (v18)
27+
* **Build Tool:** Vite
28+
* **Styling:** Tailwind CSS
29+
* **Icons:** Lucide React
30+
* **Deployment:** GitHub Pages (via GitHub Actions)
31+
32+
## 💻 Running Locally
33+
34+
If you want to run this project on your own machine:
35+
36+
1. **Clone the repository:**
37+
```bash
38+
git clone https://github.com/simonnchong/convolution_visualization_tool.git
39+
```
40+
2. **Navigate to the directory:**
41+
```bash
42+
cd convolution_visualization_tool
43+
```
44+
3. **Install dependencies (requires Node.js):**
45+
```bash
46+
npm install
47+
```
48+
4. **Start the development server:**
49+
```bash
50+
npm run dev
51+
```
52+
53+
## 📄 License
54+
55+
This project is open source and available under the [MIT License](https://www.google.com/search?q=LICENSE).

0 commit comments

Comments
 (0)