2021-04-23 16:42:55 -04:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > triton.testing.Benchmark — Triton documentation< / title >
< link rel = "stylesheet" href = "../../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/pygments.css" type = "text/css" / >
2021-07-23 04:39:46 +00:00
< link rel = "stylesheet" href = "../../_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/css/theme.css" type = "text/css" / >
2021-04-23 16:42:55 -04:00
< link rel = "stylesheet" href = "../../_static/gallery.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-binder.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-dataframe.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-rendered-html.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/css/custom.css" type = "text/css" / >
<!-- [if lt IE 9]>
< script src = "../../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../" src = "../../_static/documentation_options.js" > < / script >
2021-07-23 04:39:46 +00:00
< script data-url_root = "../../" id = "documentation_options" src = "../../_static/documentation_options.js" > < / script >
2021-04-23 16:42:55 -04:00
< script src = "../../_static/jquery.js" > < / script >
< script src = "../../_static/underscore.js" > < / script >
< script src = "../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../search.html" / >
< link rel = "next" title = "triton.testing.perf_report" href = "triton.testing.perf_report.html" / >
< link rel = "prev" title = "triton.testing.do_bench" href = "triton.testing.do_bench.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../index.html" class = "icon icon-home" > Triton
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
2021-07-23 04:39:46 +00:00
< p class = "caption" role = "heading" > < span class = "caption-text" > Getting Started< / span > < / p >
2021-04-23 16:42:55 -04:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../getting-started/installation.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../getting-started/tutorials/index.html" > Tutorials< / a > < / li >
< / ul >
2021-07-23 04:39:46 +00:00
< p class = "caption" role = "heading" > < span class = "caption-text" > Python API< / span > < / p >
2021-04-23 16:42:55 -04:00
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "../triton.html" > triton< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../triton.language.html" > triton.language< / a > < / li >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "../triton.testing.html" > triton.testing< / a > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "triton.testing.do_bench.html" > triton.testing.do_bench< / a > < / li >
< li class = "toctree-l2 current" > < a class = "current reference internal" href = "#" > triton.testing.Benchmark< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "triton.testing.perf_report.html" > triton.testing.perf_report< / a > < / li >
< / ul >
< / li >
< / ul >
2021-07-23 04:39:46 +00:00
< p class = "caption" role = "heading" > < span class = "caption-text" > Programming Guide< / span > < / p >
2021-04-23 16:42:55 -04:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../programming-guide/chapter-1/introduction.html" > Introduction< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../programming-guide/chapter-2/related-work.html" > Related Work< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../index.html" > Triton< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../index.html" class = "icon icon-home" > < / a > » < / li >
< li > < a href = "../triton.testing.html" > triton.testing< / a > » < / li >
< li > triton.testing.Benchmark< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../../_sources/python-api/generated/triton.testing.Benchmark.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "triton-testing-benchmark" >
< h1 > triton.testing.Benchmark< a class = "headerlink" href = "#triton-testing-benchmark" title = "Permalink to this headline" > ¶< / a > < / h1 >
< dl class = "py class" >
2021-07-23 04:39:46 +00:00
< dt class = "sig sig-object py" id = "triton.testing.Benchmark" >
< em class = "property" > < span class = "pre" > class< / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > triton.testing.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > Benchmark< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > self< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_names< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_vals< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_arg< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_vals< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_names< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > plot_name< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > args< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > xlabel< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > ''< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > ylabel< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > ''< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_log< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > y_log< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > color< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > styles< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#triton.testing.Benchmark" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-04-23 16:42:55 -04:00
< dd > < p > This class is used by the < code class = "code docutils literal notranslate" > < span class = "pre" > perf_report< / span > < / code > function to generate line plots with a concise API.< / p >
< dl class = "py method" >
2021-07-23 04:39:46 +00:00
< dt class = "sig sig-object py" id = "triton.testing.Benchmark.__init__" >
< span class = "sig-name descname" > < span class = "pre" > __init__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > self< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_names< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_vals< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_arg< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_vals< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > line_names< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > plot_name< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > args< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > xlabel< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > ''< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > ylabel< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > ''< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > x_log< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > y_log< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > color< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > styles< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#triton.testing.Benchmark.__init__" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-04-23 16:42:55 -04:00
< dd > < p > Constructor< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > x_names< / strong > (< em > List< / em > < em > [< / em > < em > str< / em > < em > ]< / em > ) – < / p > < / li >
< li > < p > < strong > x_vals< / strong > (< em > List< / em > < em > [< / em > < em > Any< / em > < em > ]< / em > ) – < code class = "code docutils literal notranslate" > < span class = "pre" > x_names< / span > < / code > .< / p > < / li >
< li > < p > < strong > line_arg< / strong > (< em > str< / em > ) – < / p > < / li >
< li > < p > < strong > line_vals< / strong > (< em > List< / em > < em > [< / em > < em > str< / em > < em > ]< / em > ) – < code class = "code docutils literal notranslate" > < span class = "pre" > line_arg< / span > < / code > .< / p > < / li >
< li > < p > < strong > line_names< / strong > (< em > List< / em > < em > [< / em > < em > str< / em > < em > ]< / em > ) – < / p > < / li >
< li > < p > < strong > plot_name< / strong > (< em > str< / em > ) – < / p > < / li >
< li > < p > < strong > args< / strong > (< em > List< / em > < em > [< / em > < em > str< / em > < em > ]< / em > ) – < / p > < / li >
< li > < p > < strong > xlabel< / strong > (< em > str< / em > < em > , < / em > < em > optional< / em > ) – < / p > < / li >
< li > < p > < strong > ylabel< / strong > (< em > str< / em > < em > , < / em > < em > optional< / em > ) – < / p > < / li >
< li > < p > < strong > x_log< / strong > (< em > bool< / em > < em > , < / em > < em > optional< / em > ) – < / p > < / li >
< li > < p > < strong > y_log< / strong > (< em > bool< / em > < em > , < / em > < em > optional< / em > ) – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< p class = "rubric" > Methods< / p >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "#triton.testing.Benchmark.__init__" title = "triton.testing.Benchmark.__init__" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > __init__< / span > < / code > < / a > (self, < / p > < / td >
< td > < p > Constructor< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "triton.testing.perf_report.html" class = "btn btn-neutral float-right" title = "triton.testing.perf_report" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "triton.testing.do_bench.html" class = "btn btn-neutral float-left" title = "triton.testing.do_bench" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2020, Philippe Tillet.
< / p >
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
