Browse Source

perfmodel: mention new API in ChangeLog and document all functions

Nathalie Furmento 9 years ago
parent
commit
2f52c4edbe
2 changed files with 6 additions and 0 deletions
  1. 1 0
      ChangeLog
  2. 5 0
      doc/doxygen/chapters/api/performance_model.doxy

+ 1 - 0
ChangeLog

@@ -183,6 +183,7 @@ Small changes:
     starpu_fxt_trace_user_event()
   * Update starpu_task_build() to set starpu_task::cl_arg_free to 1 if
     some arguments of type ::STARPU_VALUE are given.
+  * Simplify performance model loading API
 
 StarPU 1.1.5 (svn revision xxx)
 ==============================================

+ 5 - 0
doc/doxygen/chapters/api/performance_model.doxy

@@ -213,6 +213,11 @@ management. It should only be called by an application which is not
 calling starpu_shutdown as this function already calls it. See for
 example <c>tools/starpu_perfmodel_display.c</c>.
 
+\fn int starpu_perfmodel_load_file(const char *filename, struct starpu_perfmodel *model)
+\ingroup API_Performance_Model
+loads the performance model found in the given file. The model structure has to be
+completely zero, and will be filled with the information stored in the given file.
+
 \fn int starpu_perfmodel_load_symbol(const char *symbol, struct starpu_perfmodel *model)
 \ingroup API_Performance_Model
 loads a given performance model. The model structure has to be