1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Module holding AbstractGroupClassifier class."""
16 from abc import ABCMeta, abstractmethod
19 class AbstractGroupClassifier(object):
20 """Abstract class defining API for classifier.
22 The classifier is an object with classify() method
23 which divides data into groups containing metadata.
26 __metaclass__ = ABCMeta
29 def classify(self, values):
30 """Divide values into consecutive groups with metadata.
32 The metadata does not need to follow any specific rules,
33 although progression/regression/outlier description would be fine.
35 :param values: Sequence of runs to classify.
36 :type values: Iterable of float or of AvgStdevMetadata
37 :returns: Classified groups
38 :rtype: Iterable of RunGroup