Skip to content

Commit bc9607a

Browse files
committed
Update readme
1 parent 1ca1241 commit bc9607a

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ This library has a maser class called `IAFlow`, that has functions to management
1414
- `show_models`: to show the models that are in the internal structure of maker models.
1515
- `delete_model`: to delete a model from the internal structure of maker models.
1616

17+
There are more methods to complete a CRUD for models and datasets. You can check it once you create a instance of `IAFlow`. For now, you could check a brief description of most important methods below.
18+
1719
### Constructor
1820

1921
```python
@@ -28,17 +30,21 @@ def custom_builder(input_shape):
2830
])
2931
return model
3032

33+
params_notifier = { # Parameters for notifier, see documentation https://pypi.org/project/notify-function/#description
34+
'title': 'Training update',
35+
'webhook_url': os.environ.get('WEBHOOK_URL'),
36+
'frequency_epoch': 20 # This will send a notification every 20 epochs, by default it is every epoch
37+
}
38+
3139
ia_maker = IAFlow(
32-
val_ds=val_ds, # Dataset to validate the model, you can change this when call `train` method
33-
train_ds=train_ds, # Dataset to train the model, you can change this when call `train` method
3440
models_folder='./models', # Folder to save the models
3541
params_notifier=params_notifier, # Notifier to send notification to discord channel, email or telegram (all this is optional)
3642
builder_function=custom_builder # Function to build the model, you can change this when call `train` method
3743
)
3844
```
3945

4046
## `add_dataset`
41-
This function add a new dataset to the internal structure of maker models to build later to training.
47+
This function add a new dataset to the internal structure of maker models to build later to training. The dataset could be an instance of `tf.data.Dataset`, list of Tensors of whatever that could be passes to the `fit` method of `tf.keras.Model`.
4248

4349
```python
4450
ia_maker.add_dataset(
@@ -51,6 +57,8 @@ ia_maker.add_dataset(
5157
)
5258
```
5359

60+
> So far, the shuffle buffer is only applied to datasets that are an instance of `tf.data.Dataset`.
61+
5462
### `add_model` method
5563
The build method is used to create a model in a defined structure of folder. As below:
5664

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="iaflow",
8-
version="2.1.0",
8+
version="2.1.1",
99
author="Enmanuel Magallanes Pinargote",
1010
author_email="enmanuelmag@cardor.dev",
1111
description="This library help to create models with identifiers, checkpoints, logs and metadata automatically, in order to make the training process more efficient and traceable.",

0 commit comments

Comments
 (0)