/
fcn.py
231 lines (195 loc) · 7.71 KB
/
fcn.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
"""Fully Connected Neural Network (CNN) for classification."""
__author__ = ["James-Large", "AurumnPegasus"]
__all__ = ["FCNClassifier"]
from copy import deepcopy
from sklearn.utils import check_random_state
from sktime.classification.deep_learning.base import BaseDeepClassifier
from sktime.networks.fcn import FCNNetwork
from sktime.utils.validation._dependencies import _check_dl_dependencies
class FCNClassifier(BaseDeepClassifier):
"""Fully Connected Neural Network (FCN), as described in [1]_.
Parameters
----------
should inherited fields be listed here?
n_epochs : int, default = 2000
the number of epochs to train the model
batch_size : int, default = 16
the number of samples per gradient update.
random_state : int or None, default=None
Seed for random number generation.
verbose : boolean, default = False
whether to output extra information
loss : string, default="mean_squared_error"
fit parameter for the keras model
optimizer : keras.optimizer, default=keras.optimizers.Adam(),
metrics : list of strings, default=["accuracy"],
activation : string or a tf callable, default="sigmoid"
Activation function used in the output linear layer.
List of available activation functions:
https://keras.io/api/layers/activations/
use_bias : boolean, default = True
whether the layer uses a bias vector.
optimizer : keras.optimizers object, default = Adam(lr=0.01)
specify the optimizer and the learning rate to be used.
Notes
-----
Adapted from the implementation from Fawaz et. al
https://github.com/hfawaz/dl-4-tsc/blob/master/classifiers/fcn.py
References
----------
.. [1] Zhao et. al, Convolutional neural networks for time series classification,
Journal of Systems Engineering and Electronics, 28(1):2017.
Examples
--------
>>> from sktime.classification.deep_learning.fcn import FCNClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True)
>>> fcn = FCNClassifier(n_epochs=20,batch_size=4) # doctest: +SKIP
>>> fcn.fit(X_train, y_train) # doctest: +SKIP
FCNClassifier(...)
"""
_tags = {
# packaging info
# --------------
"authors": ["James-Large", "AurumnPegasus"],
"maintainers": ["James-Large", "AurumnPegasus"],
# estimator type handled by parent class
}
def __init__(
self,
n_epochs=2000,
batch_size=16,
callbacks=None,
verbose=False,
loss="categorical_crossentropy",
metrics=None,
random_state=None,
activation="sigmoid",
use_bias=True,
optimizer=None,
):
_check_dl_dependencies(severity="error")
self.callbacks = callbacks
self.n_epochs = n_epochs
self.batch_size = batch_size
self.verbose = verbose
self.loss = loss
self.metrics = metrics
self.random_state = random_state
self.activation = activation
self.use_bias = use_bias
self.optimizer = optimizer
self.history = None
super().__init__()
self._network = FCNNetwork(random_state=self.random_state)
def build_model(self, input_shape, n_classes, **kwargs):
"""Construct a compiled, un-trained, keras model that is ready for training.
In sktime, time series are stored in numpy arrays of shape (d,m), where d
is the number of dimensions, m is the series length. Keras/tensorflow assume
data is in shape (m,d). This method also assumes (m,d). Transpose should
happen in fit.
Parameters
----------
input_shape : tuple
The shape of the data fed into the input layer, should be (m,d)
n_classes: int
The number of classes, which becomes the size of the output layer
Returns
-------
output : a compiled Keras Model
"""
import tensorflow as tf
from tensorflow import keras
tf.random.set_seed(self.random_state)
if self.metrics is None:
metrics = ["accuracy"]
else:
metrics = self.metrics
input_layer, output_layer = self._network.build_network(input_shape, **kwargs)
output_layer = keras.layers.Dense(
units=n_classes, activation=self.activation, use_bias=self.use_bias
)(output_layer)
self.optimizer_ = (
keras.optimizers.Adam(learning_rate=0.01)
if self.optimizer is None
else self.optimizer
)
model = keras.models.Model(inputs=input_layer, outputs=output_layer)
model.compile(
loss=self.loss,
optimizer=self.optimizer_,
metrics=metrics,
)
return model
def _fit(self, X, y):
"""Fit the classifier on the training set (X, y).
Parameters
----------
X : np.ndarray of shape = (n_instances (n), n_dimensions (d), series_length (m))
The training input samples.
y : np.ndarray of shape n
The training data class labels.
Returns
-------
self : object
"""
y_onehot = self.convert_y_to_keras(y)
# Transpose to conform to Keras input style.
X = X.transpose(0, 2, 1)
check_random_state(self.random_state)
self.input_shape = X.shape[1:]
self.model_ = self.build_model(self.input_shape, self.n_classes_)
if self.verbose:
self.model_.summary()
self.history = self.model_.fit(
X,
y_onehot,
batch_size=self.batch_size,
epochs=self.n_epochs,
verbose=self.verbose,
callbacks=deepcopy(self.callbacks) if self.callbacks else [],
)
return self
@classmethod
def get_test_params(cls, parameter_set="default"):
"""Return testing parameter settings for the estimator.
Parameters
----------
parameter_set : str, default="default"
Name of the set of test parameters to return, for use in tests. If no
special parameters are defined for a value, will return ``"default"`` set.
For classifiers, a "default" set of parameters should be provided for
general testing, and a "results_comparison" set for comparing against
previously recorded results if the general set does not produce suitable
probabilities to compare against.
Returns
-------
params : dict or list of dict, default={}
Parameters to create testing instances of the class.
Each dict are parameters to construct an "interesting" test instance, i.e.,
``MyClass(**params)`` or ``MyClass(**params[i])`` creates a valid test
instance.
``create_test_instance`` uses the first (or only) dictionary in ``params``.
"""
from sktime.utils.validation._dependencies import _check_soft_dependencies
param1 = {
"n_epochs": 10,
"batch_size": 4,
"use_bias": False,
}
param2 = {
"n_epochs": 12,
"batch_size": 6,
"use_bias": True,
}
test_params = [param1, param2]
if _check_soft_dependencies("keras", severity="none"):
from keras.callbacks import LambdaCallback
test_params.append(
{
"n_epochs": 2,
"callbacks": [LambdaCallback()],
}
)
return test_params