From e5694f0764898d68ee06b03c7b6ddf0b0982e41b Mon Sep 17 00:00:00 2001
From: AhmedElshobaky <ahmedalycess@gmail.com>
Date: Tue, 6 Aug 2024 16:53:07 +0200
Subject: [PATCH] docs: write project readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 2fb7400..092217b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
 # neural-network-framework
 Build a Micro Neural Network Framework (like Pytorch or Tensorflow) using only Numpy
+
+## Layers:
+### Main Blocks:
+    - Fully Connected
+    - Convolutional
+    - RNN
+### CNN Blocks
+    - Pooling
+    - Flatten
+### RNN Blocks:
+    - Dropout
+    - Batch normalization
+### Activation Functions:
+    - ReLU
+    - Soft max
+    - Sigmoid
+
+## Optimization:
+### Optimizers: 
+    - Stochastic Gradient Descent
+    - SGD With Momentum
+    - Adam
+### Loss Functions:
+    - Cross Entropy Loss
+### Regularizers:
+    - L1
+    - L2