You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,8 @@ This library has a maser class called `IAFlow`, that has functions to management
14
14
-`show_models`: to show the models that are in the internal structure of maker models.
15
15
-`delete_model`: to delete a model from the internal structure of maker models.
16
16
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.
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
+
31
39
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
34
40
models_folder='./models', # Folder to save the models
35
41
params_notifier=params_notifier, # Notifier to send notification to discord channel, email or telegram (all this is optional)
36
42
builder_function=custom_builder # Function to build the model, you can change this when call `train` method
37
43
)
38
44
```
39
45
40
46
## `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`.
42
48
43
49
```python
44
50
ia_maker.add_dataset(
@@ -51,6 +57,8 @@ ia_maker.add_dataset(
51
57
)
52
58
```
53
59
60
+
> So far, the shuffle buffer is only applied to datasets that are an instance of `tf.data.Dataset`.
61
+
54
62
### `add_model` method
55
63
The build method is used to create a model in a defined structure of folder. As below:
Copy file name to clipboardExpand all lines: setup.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
setuptools.setup(
7
7
name="iaflow",
8
-
version="2.1.0",
8
+
version="2.1.1",
9
9
author="Enmanuel Magallanes Pinargote",
10
10
author_email="enmanuelmag@cardor.dev",
11
11
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