resources/libraries/python/MLRsearch/AbstractSearchAlgorithm.py

   1 # Copyright (c) 2020 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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Module defining AbstractSearchAlgorithm class."""
  15
  16 from abc import ABCMeta, abstractmethod
  17
  18
  19 class AbstractSearchAlgorithm(metaclass=ABCMeta):
  20     """Abstract class defining common API for search algorithms."""
  21
  22     def __init__(self, measurer):
  23         """Store the rate provider.
  24
  25         :param measurer: Object able to perform trial or composite measurements.
  26         :type measurer: AbstractMeasurer.AbstractMeasurer
  27         """
  28         # TODO: Type check for AbstractMeasurer?
  29         self.measurer = measurer
  30
  31     @abstractmethod
  32     def narrow_down_ndr_and_pdr(
  33             self, min_rate, max_rate, packet_loss_ratio):
  34         """Perform measurements to narrow down intervals, return them.
  35
  36         This will be renamed when custom loss ratio lists are supported.
  37
  38         :param min_rate: Minimal target transmit rate [tps].
  39             Usually, tests are set to fail if search reaches this or below.
  40         :param max_rate: Maximal target transmit rate [tps].
  41             Usually computed from line rate and various other limits,
  42             to prevent failures or duration stretching in Traffic Generator.
  43         :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
  44         :type min_rate: float
  45         :type max_rate: float
  46         :type packet_loss_ratio: float
  47         :returns: Structure containing narrowed down intervals
  48             and their measurements.
  49         :rtype: NdrPdrResult.NdrPdrResult
  50         """
  51         # TODO: Do we agree on arguments related to precision or trial duration?