# -*- coding:utf-8 -*- #
#
# Anomaly Detection Framework
# Copyright (C) 2018 Bluekiri BigData Team <bigdata@bluekiri.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from anomalydetection.backend.entities.output_message import AnomalyResult
[docs]class BaseEngine(object):
"""
Base class for any Engine implementation.
"""
[docs] def predict(self, value: float, **kwargs) -> AnomalyResult:
"""
Predict if the given value is anomalous.
:param value: value to predict
:param kwargs: extra data to make the prediction
:return: anomaly result
"""
raise NotImplementedError("To implement in child classes.")