docs: write project readme

ahmedalycess · Aug 6, 2024 · e5694f0 · e5694f0
1 parent 3d90568
commit e5694f0
Showing 1 changed file with 27 additions and 0 deletions.
diff --git 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