From d8c05b528b5a75377848d130286bc997da06a792 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Fri, 30 Dec 2016 14:08:15 +0800 Subject: Implement plan, qpi and metric constructors - separate runner from `plan` and move `plan` to `loader` - rename `algorithm` to `formula` - use `numpy` for formulas - update sample qpi and metrics Change-Id: I3131ca79907376f2de31d6cb920bd7d0230664a6 Signed-off-by: Yujun Zhang --- qtip/base/constant.py | 6 +++--- qtip/base/error.py | 13 +++++++++++++ qtip/cli/commands/cmd_plan.py | 3 ++- qtip/loader/base.py | 11 +++++------ qtip/loader/metric.py | 2 +- qtip/loader/plan.py | 27 ++++++++++++++++++++++++++ qtip/loader/qpi.py | 22 ++++++++++++++++++++- qtip/runner/__init__.py | 43 +++++++++++++++++++++++++++++++++++++++++ qtip/runner/base.py | 45 ------------------------------------------- qtip/runner/plan.py | 25 ------------------------ qtip/utils/formula.py | 29 ++++++++++++++++++++++++++++ 11 files changed, 144 insertions(+), 82 deletions(-) create mode 100644 qtip/loader/plan.py delete mode 100644 qtip/runner/base.py delete mode 100644 qtip/runner/plan.py create mode 100644 qtip/utils/formula.py (limited to 'qtip') diff --git a/qtip/base/constant.py b/qtip/base/constant.py index 187f0706..76481b47 100644 --- a/qtip/base/constant.py +++ b/qtip/base/constant.py @@ -8,8 +8,8 @@ ############################################################################## -class AlgoName(object): - """algorithm names""" +class FormulaName(object): + """formula names""" ARITHMETIC_MEAN = 'arithmetic mean' WEIGHTED_ARITHMETIC_MEAN = 'weighted arithmetic mean' GEOMETRIC_MEAN = 'geometric mean' @@ -37,7 +37,7 @@ class PropName(object): # spec SECTIONS = 'sections' WEIGHT = 'weight' - ALGORITHM = 'algorithm' + FORMULA = 'formula' METRICS = 'metrics' WORKLOADS = 'workloads' # plan diff --git a/qtip/base/error.py b/qtip/base/error.py index d364c532..01a7f7a6 100644 --- a/qtip/base/error.py +++ b/qtip/base/error.py @@ -21,3 +21,16 @@ class NotFound(QtipError): def __init__(self, module, package='qtip'): self.package = package self.module = module + + +class ToBeDoneError(QtipError): + """something still to be done""" + def __init__(self, method, module): + self.method = method + self.module = module + + +def make_tbd(method, module='qtip'): + def tbd(): + raise ToBeDoneError(method, module) + return tbd diff --git a/qtip/cli/commands/cmd_plan.py b/qtip/cli/commands/cmd_plan.py index 01bf8251..6f622e5a 100644 --- a/qtip/cli/commands/cmd_plan.py +++ b/qtip/cli/commands/cmd_plan.py @@ -9,7 +9,8 @@ import click from prettytable import PrettyTable -from qtip.runner.plan import Plan + +from qtip.loader.plan import Plan @click.group() diff --git a/qtip/loader/base.py b/qtip/loader/base.py index f7fcb669..2f5ab67a 100644 --- a/qtip/loader/base.py +++ b/qtip/loader/base.py @@ -20,13 +20,13 @@ ROOT_DIR = 'benchmarks' class BaseLoader(object): """Abstract class of QTIP benchmark loader""" - DEFAULT_DIR = '.' + RELATIVE_PATH = '.' _paths = [path.join(path.dirname(__file__), path.pardir, path.pardir, ROOT_DIR)] def __init__(self, name, paths=None): self._file = name - self._abspath = self._find(name, paths) + self._abspath = self._find(name, paths=paths) try: content = yaml.safe_load(file(self._abspath)) @@ -38,12 +38,11 @@ class BaseLoader(object): else path.splitext(name)[0] self.content = content - def _find(self, name, paths): + def _find(self, name, paths=None): """find a benchmark in searching paths""" paths = self._paths if paths is None else paths - name = path.join(self.DEFAULT_DIR, name) for p in paths: - abspath = path.join(p, name) + abspath = path.join(p, self.RELATIVE_PATH, name) if path.exists(abspath): return abspath raise NotFound(name, paths) @@ -52,7 +51,7 @@ class BaseLoader(object): def list_all(cls, paths=None): """list all available benchmarks""" paths = cls._paths if paths is None else paths - names = chain.from_iterable([listdir(path.join(p, cls.DEFAULT_DIR)) + names = chain.from_iterable([listdir(path.join(p, cls.RELATIVE_PATH)) for p in paths]) for name in names: item = cls(name, paths=paths) diff --git a/qtip/loader/metric.py b/qtip/loader/metric.py index d6174e8f..8b6fa5d3 100644 --- a/qtip/loader/metric.py +++ b/qtip/loader/metric.py @@ -13,4 +13,4 @@ from base import BaseLoader class MetricSpec(BaseLoader): """metrics in QTIP are categorized by performance test tools, such as dhrystone, whetstone and etc""" - DEFAULT_DIR = 'metric' + RELATIVE_PATH = 'metric' diff --git a/qtip/loader/plan.py b/qtip/loader/plan.py new file mode 100644 index 00000000..cf517ea2 --- /dev/null +++ b/qtip/loader/plan.py @@ -0,0 +1,27 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +from qtip.base.constant import PropName +from qtip.loader.base import BaseLoader +from qtip.loader.qpi import QPISpec + + +class Plan(BaseLoader): + """ + a benchmark plan is consist of configuration and a QPI list + """ + + RELATIVE_PATH = 'plan' + + def __init__(self, name, paths=None): + super(Plan, self).__init__(name, paths) + + self.qpis = [QPISpec(qpi, paths=paths) + for qpi in self.content[PropName.QPIS]] diff --git a/qtip/loader/qpi.py b/qtip/loader/qpi.py index 2972cbd7..cfa918c5 100644 --- a/qtip/loader/qpi.py +++ b/qtip/loader/qpi.py @@ -8,6 +8,10 @@ ############################################################################## from base import BaseLoader +from metric import MetricSpec + +from qtip.base.constant import PropName +from qtip.utils.formula import Formula class QPISpec(BaseLoader): @@ -15,4 +19,20 @@ class QPISpec(BaseLoader): a QPI specification defines how to calculate a performance index from collected metrics. """ - DEFAULT_DIR = 'QPI' + RELATIVE_PATH = 'QPI' + + def __init__(self, name, paths=None): + super(QPISpec, self).__init__(name, paths=paths) + content = self.content + self.formula = Formula(content[PropName.FORMULA]) + self.sections = [Section(record, paths=paths) + for record in content[PropName.SECTIONS]] + + +class Section(object): + def __init__(self, content, paths=None): + self.name = content[PropName.NAME] + self.weight = content[PropName.WEIGHT] + self.formula = Formula(content[PropName.FORMULA]) + self.metrics = [MetricSpec(record, paths=paths) + for record in content[PropName.METRICS]] diff --git a/qtip/runner/__init__.py b/qtip/runner/__init__.py index e69de29b..eab81156 100644 --- a/qtip/runner/__init__.py +++ b/qtip/runner/__init__.py @@ -0,0 +1,43 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from qtip.base.constant import PkgName, PropName +from qtip.base.error import NotFound +from qtip.collector.stdout import StdoutCollector +from qtip.driver.random import RandomDriver +from qtip.reporter.console import ConsoleReporter + + +class Runner(object): + def __init__(self, spec, config=None): + if config is None: + config = spec[PropName.CONFIG] + + driver_name = config[PropName.DRIVER] + collector_name = config[PropName.COLLECTOR] + reporter_name = config[PropName.REPORTER] + + # TODO(yujunz) dynamically load modules by name + + if driver_name == 'random': + self.driver = RandomDriver() + else: + raise NotFound(driver_name, package=PkgName.DRIVER) + + if collector_name == 'stdout': + self.collector = StdoutCollector() + else: + raise NotFound(collector_name, + package=PkgName.COLLECTOR) + + if reporter_name == 'console': + self.reporter = ConsoleReporter() + else: + raise NotFound(reporter_name, + package=PkgName.REPORTER) diff --git a/qtip/runner/base.py b/qtip/runner/base.py deleted file mode 100644 index 07fba104..00000000 --- a/qtip/runner/base.py +++ /dev/null @@ -1,45 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.constant import PkgName, PropName -from qtip.base.error import NotFound -from qtip.collector.logfile import LogfileCollector -from qtip.driver.sample import SampleDriver -from qtip.loader.base import BaseLoader -from qtip.reporter.console import ConsoleReporter - - -class BaseRunner(BaseLoader): - def __init__(self, name, paths=None, config=None): - super(BaseRunner, self).__init__(name, paths=paths) - if config is None: - config = self.content[PropName.CONFIG] - - driver_name = config[PropName.DRIVER] - collector_name = config[PropName.COLLECTOR] - reporter_name = config[PropName.REPORTER] - - # TODO(yujunz) dynamically load modules by name - - if driver_name == 'sample': - self.driver = SampleDriver() - else: - raise NotFound(driver_name, package=PkgName.DRIVER) - - if collector_name == 'logfile': - self.collector = LogfileCollector() - else: - raise NotFound(collector_name, - package=PkgName.COLLECTOR) - - if reporter_name == 'console': - self.reporter = ConsoleReporter() - else: - raise NotFound(reporter_name, - package=PkgName.REPORTER) diff --git a/qtip/runner/plan.py b/qtip/runner/plan.py deleted file mode 100644 index f6c1c3bb..00000000 --- a/qtip/runner/plan.py +++ /dev/null @@ -1,25 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.constant import PropName -from qtip.runner.base import BaseRunner -from qtip.loader.qpi import QPISpec - - -class Plan(BaseRunner): - """ - a benchmark plan is consist of configuration and a QPI list - """ - - DEFAULT_DIR = 'plan' - - def __init__(self, name, paths=None): - super(Plan, self).__init__(name, paths) - self.qpis = [QPISpec(qpi, paths=paths) - for qpi in self.content[PropName.QPIS]] diff --git a/qtip/utils/formula.py b/qtip/utils/formula.py new file mode 100644 index 00000000..cdfbae86 --- /dev/null +++ b/qtip/utils/formula.py @@ -0,0 +1,29 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +import numpy + +from qtip.base.error import make_tbd +from qtip.base.constant import FormulaName + + +MAPPING = { + FormulaName.ARITHMETIC_MEAN: numpy.mean, + FormulaName.WEIGHTED_ARITHMETIC_MEAN: numpy.average, + # TODO(yujunz) find or implement the method + FormulaName.GEOMETRIC_MEAN: make_tbd(FormulaName.GEOMETRIC_MEAN, __name__), + # TODO(yujunz) find or implement the method + FormulaName.WEIGHTED_GEOMETRIC_MEAN: + make_tbd(FormulaName.GEOMETRIC_MEAN, __name__)} + + +class Formula: + """calculate a score from give data""" + def __init__(self, name): + self.calculate = MAPPING[name] -- cgit 1.2.3-korg