Browse Source

also document the starpu_perfmodel_display option

Samuel Thibault 6 years ago
parent
commit
0a519ba38f
1 changed files with 24 additions and 1 deletions
  1. 24 1
      doc/doxygen/chapters/380_offline_performance_tools.doxy

+ 24 - 1
doc/doxygen/chapters/380_offline_performance_tools.doxy

@@ -2,7 +2,7 @@
  *
  * Copyright (C) 2011,2012,2015-2017                      Inria
  * Copyright (C) 2010-2019                                CNRS
- * Copyright (C) 2009-2011,2014-2017                      Université de Bordeaux
+ * Copyright (C) 2009-2011,2014-2017,2019                 Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -361,6 +361,29 @@ The same can also be achieved by using StarPU's library API, see
 starpu_perfmodel_load_symbol(). The source code of the tool
 <c>starpu_perfmodel_display</c> can be a useful example.
 
+An XML output can also be printed by using the <c>-x</c> option:
+\verbatim
+tools/starpu_perfmodel_display -x -s non_linear_memset_regression_based 
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE StarPUPerfmodel SYSTEM "starpu-perfmodel.dtd">
+<!-- symbol non_linear_memset_regression_based -->
+<!-- All times in us -->
+<perfmodel version="45">
+  <combination>
+    <device type="CPU" id="0" ncores="1"/>
+    <implementation id="0">
+      <!-- cpu0_impl0 (Comb0) -->
+      <!-- time = a size ^b + c -->
+      <nl_regression a="5.429195e-04" b="8.654899e-01" c="9.009313e-01"/>
+      <entry footprint="a3d3725e" size="4096" flops="0.000000e+00" mean="4.763200e+00" deviation="7.650928e-01" nsample="100"/>
+      <entry footprint="870a30aa" size="8192" flops="0.000000e+00" mean="1.827970e+00" deviation="2.037181e-01" nsample="100"/>
+      <entry footprint="48e988e9" size="16384" flops="0.000000e+00" mean="2.652800e+00" deviation="1.876459e-01" nsample="100"/>
+      <entry footprint="961e65d2" size="32768" flops="0.000000e+00" mean="4.255530e+00" deviation="3.518025e-01" nsample="100"/>
+    </implementation>
+  </combination>
+</perfmodel>
+\endverbatim
+
 The tool <c>starpu_perfmodel_plot</c> can be used to draw performance
 models. It writes a <c>.gp</c> file in the current directory, to be
 run with the tool <c>gnuplot</c>, which shows the corresponding curve.