Skip to content

Commit 1a6e258

Browse files
author
oujago@gmail.com
committed
improve README
1 parent ff6b3f8 commit 1a6e258

File tree

1 file changed

+57
-76
lines changed

1 file changed

+57
-76
lines changed

README.rst

Lines changed: 57 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,11 @@
2222

2323
.. https://codeclimate.com/github/oujago/NumpyDL/badges/gpa.svg
2424
:target: https://codeclimate.com/github/oujago/NumpyDL
25-
:alt: Code Climate
2625
27-
.. images:: https://codeclimate.com/github/oujago/NumpyDL/badges/issue_count.svg
26+
.. image:: https://codeclimate.com/github/oujago/NumpyDL/badges/issue_count.svg
2827
:target: https://codeclimate.com/github/oujago/NumpyDL
2928

30-
.. https://img.shields.io/github/issues/oujago/NumpyDL.svg
31-
:target: https://github.com/oujago/NumpyDL
32-
33-
.. https://img.shields.io/github/forks/oujago/NumpyDL.svg
34-
:target: https://github.com/oujago/NumpyDL
35-
36-
.. https://img.shields.io/github/stars/oujago/NumpyDL.svg
29+
.. image:: https://img.shields.io/github/issues/oujago/NumpyDL.svg
3730
:target: https://github.com/oujago/NumpyDL
3831

3932
.. image:: https://zenodo.org/badge/83100910.svg
@@ -66,6 +59,7 @@ Its main features are:
6659
5. *API* like ``Keras`` library
6760
6. *Examples* for several AI tasks
6861
7. *Application* for a toy chatbot
62+
8. *Mobile friendly* documents
6963

7064

7165
Documentation
@@ -104,19 +98,17 @@ Examples
10498
``NumpyDL`` provides several examples of AI tasks:
10599

106100
* sentence classification
107-
* LSTM in `examples/lstm_sentence_classification.py`
108-
* CNN in `examples/cnn_sentence_classification.py`
101+
* LSTM in *examples/lstm_sentence_classification.py*
102+
* CNN in *examples/cnn_sentence_classification.py*
109103
* mnist handwritten recognition
110-
* MLP in `examples/mlp-mnist.py`
111-
* MLP in `examples/mlp-digits.py`
112-
* CNN in `examples/cnn-minist.py`
104+
* MLP in *examples/mlp-mnist.py*
105+
* MLP in *examples/mlp-digits.py*
106+
* CNN in *examples/cnn-minist.py*
113107
* language modeling
114-
* RNN in `examples/rnn-character-lm.py`
115-
* RNN in `examples/rnn-character-lm2.py`
116-
* LSTM in `examples/lstm-character-lm.py`
117-
* LSTM in `examples/lstm-character-lm2.py`
108+
* RNN in *examples/rnn-character-lm.py*
109+
* LSTM in *examples/lstm-character-lm.py*
118110

119-
One concrete code example in `examples/mlp-digits.py`:
111+
One concrete code example in *examples/mlp-digits.py*:
120112

121113
.. code-block:: python
122114
@@ -151,7 +143,7 @@ Applications
151143
``NumpyDL`` provides one toy application:
152144

153145
* Chatbot
154-
* seq2seq in `applications/chatbot/model.py`
146+
* seq2seq in *applications/chatbot/model.py*
155147

156148

157149
And its final result:
@@ -165,65 +157,54 @@ Supports
165157

166158
``NumpyDL`` supports following deep learning techniques:
167159

168-
169160
* Layers
170-
171-
1. Linear
172-
2. Dense
173-
3. Softmax
174-
4. Dropout
175-
5. Convolution
176-
6. Embedding
177-
7. BatchNormal
178-
8. MeanPooling
179-
9. MaxPooling
180-
10. SimpleRNN
181-
11. GRU
182-
12. LSTM
183-
13. Flatten
184-
14. DimShuffle
185-
161+
* Linear
162+
* Dense
163+
* Softmax
164+
* Dropout
165+
* Convolution
166+
* Embedding
167+
* BatchNormal
168+
* MeanPooling
169+
* MaxPooling
170+
* SimpleRNN
171+
* GRU
172+
* LSTM
173+
* Flatten
174+
* DimShuffle
186175
* Optimizers
187-
188-
1. Momentum
189-
2. NesterovMomentum
190-
3. Adagrad
191-
4. RMSprop
192-
5. Adadelta
193-
6. Adam
194-
7. Adamax
195-
176+
* SGD
177+
* Momentum
178+
* NesterovMomentum
179+
* Adagrad
180+
* RMSprop
181+
* Adadelta
182+
* Adam
183+
* Adamax
196184
* Objectives
197-
198-
1. MeanSquaredError
199-
2. HellingerDistance
200-
3. BinaryCrossEntropy
201-
4. SoftmaxCategoricalCrossEntropy
202-
203-
185+
* MeanSquaredError
186+
* HellingerDistance
187+
* BinaryCrossEntropy
188+
* SoftmaxCategoricalCrossEntropy
204189
* Initializations
205-
206-
1. Zero
207-
2. One
208-
3. Uniform
209-
4. Normal
210-
5. LecunUniform
211-
6. GlorotUniform
212-
7. GlorotNormal
213-
8. HeNormal
214-
9. HeUniform
215-
10. Orthogonal
216-
217-
190+
* Zero
191+
* One
192+
* Uniform
193+
* Normal
194+
* LecunUniform
195+
* GlorotUniform
196+
* GlorotNormal
197+
* HeNormal
198+
* HeUniform
199+
* Orthogonal
218200
* Activations
219-
220-
1. Sigmoid
221-
2. Tanh
222-
3. ReLU
223-
4. Linear
224-
5. Softmax
225-
6. Elliot
226-
7. SymmetricElliot
227-
8. SoftPlus
228-
9. SoftSign
201+
* Sigmoid
202+
* Tanh
203+
* ReLU
204+
* Linear
205+
* Softmax
206+
* Elliot
207+
* SymmetricElliot
208+
* SoftPlus
209+
* SoftSign
229210

0 commit comments

Comments
 (0)