Skip to content

Commit 3116a8a

Browse files
committed
docs(readme): update²
1 parent c8f1794 commit 3116a8a

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -128,16 +128,6 @@ model.compile(loss_function="mse", optimizer='adam') # you can either put acron
128128
model.fit(X_train, y_train, epochs=100, batch_size=128, metrics=['accuracy'])
129129
```
130130

131-
You can also save and load models:
132-
133-
```python
134-
# Save a model
135-
model.save('my_model.json')
136-
137-
# Load a model
138-
model = Model.load('my_model.json')
139-
```
140-
141131
### Image Compression
142132

143133
```python
@@ -248,7 +238,18 @@ model.compile(loss_function="cels", optimizer=Adam(learning_rate=5e-5, beta_1=0.
248238
history = model.fit(x_train, y_train, epochs=50, batch_size=32, verbose=True, callbacks=[EarlyStopping(monitor='loss', patience=20), LearningRateScheduler(schedule="warmup_cosine", initial_learning_rate=5e-5, verbose=True)],validation_data=(x_test, y_test), metrics=['bleu_score'])
249239
```
250240

251-
## 📜 Output of the example file
241+
> [!NOTE]
242+
> You can also save and load models using the `save` and `load` methods.
243+
244+
```python
245+
# Save a model
246+
model.save('my_model.json')
247+
248+
# Load a model
249+
model = Model.load('my_model.json')
250+
```
251+
252+
## 📜 Some outputs and easy usages
252253

253254
### Here is the decision boundary on a Binary Classification (breast cancer dataset):
254255

@@ -275,6 +276,10 @@ history = model.fit(x_train, y_train, epochs=50, batch_size=32, verbose=True, ca
275276

276277
![dino](resources/img/dino.png)
277278

279+
### Here is a MNIST generated image using a GAN.
280+
281+
![mnist_generated](resources/img/mnist_generated.gif)
282+
278283
**You can __of course__ use the library for any dataset you want.**
279284

280285
## ✏️ Edit the library
@@ -291,6 +296,7 @@ And test your changes on the examples.
291296

292297
- [ ] Add support for stream dataset loading to allow loading large datasets (larger than your RAM)
293298
- [ ] Visual updates (tabulation of model.summary() parameters calculation, colorized progress bar, etc.)
299+
- [ ] Better save format (like h5py)
294300
- [ ] Add cuDNN support to allow the use of GPUs
295301

296302
## 🐞 Know issues

resources/img/mnist_generated.gif

61.8 KB
Loading

0 commit comments

Comments
 (0)