Skip to content

Commit db55bb6

Browse files
committed
Added API reference in README
1 parent 2c4aee4 commit db55bb6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,27 @@ filename = "model.json"
127127
network = NeuralNetwork.load_model(filename)
128128
```
129129

130+
<br/>
131+
<br/>
132+
133+
## API
134+
#### [`NeuralNetwork`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/NeuralNetwork.md)
135+
#### [`Layer`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/Layer.md)
136+
#### [`Dataset`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/Dataset.md)
137+
#### [`ActivationFunction`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/ActivationFunction.md)
138+
- Sigmoid
139+
- Tanh
140+
- Softmax
141+
- Identity
142+
- ReLu
143+
#### [`LossFunctions`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/LossFunctions.md)
144+
- MSE (Mean Squared Error)
145+
- CE (Corss Entropy)
146+
#### [`Utils`](https://github.com/Subhash3/Neural_Net_Using_NumPy/blob/master/docs/markdown/Utils.md)
147+
148+
<br/>
149+
<br/>
150+
130151
### Todo
131152
- [x] Generalize the gradient descent algorithm
132153
- [x] Generalise the loss function => Write a separate class for it!

0 commit comments

Comments
 (0)