/[escript]/trunk/escript/py_src/benchmark.py
ViewVC logotype

Annotation of /trunk/escript/py_src/benchmark.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 393 - (hide annotations)
Tue Dec 20 05:40:43 2005 UTC (13 years, 11 months ago) by gross
File MIME type: text/x-python
File size: 13318 byte(s)
set number of threads works now
1 gross 379 filter# $Id:$
2 gross 364
3     #
4     # COPYRIGHT ACcESS 2004 - All Rights Reserved
5     #
6     # This software is the property of ACcESS. No part of this code
7     # may be copied in any form or by any means without the expressed written
8     # consent of ACcESS. Copying, use or modification of this software
9     # by any unauthorised person is illegal unless that
10     # person has a software license agreement with ACcESS.
11     #
12    
13     """
14     A simple framework to run benchmarks under OPENMP and to summarize the results in tables for instance in HTML
15    
16     @var __author__: name of author
17     @var __licence__: licence agreement
18     var __url__: url entry point on documentation
19     @var __version__: version
20     @var __date__: date of the version
21     """
22    
23     __author__="Lutz Gross, l.gross@uq.edu.au"
24     __licence__="contact: esys@access.uq.edu.au"
25     __url__="http://www.iservo.edu.au/esys/escript"
26     __version__="$Revision:$"
27     __date__="$Date:$"
28    
29     import os,socket,time,sys
30 gross 393 from esys.escript import setNumberOfThreads
31 gross 364
32     class BenchmarkSuite(object):
33     """
34     framework to run a bunch of L{Benchmark}s with the object to create a table of statistics.
35     @var MAX_LEVEL: maximum number of level in headers for output
36     """
37     MAX_LEVEL=5
38     def __init__(self,name=None):
39     """
40     sets up a suite of benchmarks
41    
42     @param name: name of the benchmark suite. If no name is given the class name is used.
43     @type name: C{str}
44     """
45     super(BenchmarkSuite,self).__init__()
46     self.__benchmarks=[]
47     self.__scale=1
48     if name==None:
49     self.__name=self.__class__.__name__
50     else:
51     self.__name=name
52    
53     def __str__(self):
54     """
55     returns the name of the benchmark suite
56    
57     @return: name
58     @rtype: C{str}
59     """
60     return self.__name
61     def addBenchmark(self,benchmark):
62     """
63     adds a L{Benchmark} to the suite
64    
65     @param benchmark: adds a new L{Benchmark} to the suite
66     @type benchmark: L{Benchmark}
67     """
68     self.__benchmarks.append(benchmark)
69     def __len__(self):
70     """
71     returns the number of benchmarks in the suite
72    
73     @return: number of benchmarks
74     @rtype: C{int}
75     """
76     return len(self.__benchmarks)
77     def __getitem__(self,i):
78     """
79     returns the i-th benchmark in the suite through self[i]
80    
81     @param i: index of the requested benchmark
82     @type i: C{int}
83     @return: i-th benchmark
84     @rtype: L{Benchmark}
85    
86     """
87     return self.__benchmarks[i]
88     def run(self,scale=1):
89     """
90     runs all benchmarks
91    
92     @param scale: defines the number of (OpenMP) threads to be used. If scale is a scalar all benchmarks
93     are run with scale number of threads. If scale is a C{list}, the p-th problem in each of the benchmarks
94 gross 387 in the suite is run with scale[p] threads. If scale[p]<1 teh p-th problem is omitted.
95 gross 364 @type scale: C{int} or C{list} of C{int}s.
96     """
97     self.__scale=scale
98 gross 379 for i in range(len(self)): self[i].run(scale=scale)
99     def getHTML(self,filter,level=1):
100 gross 364 """
101     returns the results of the last benchmark run in HTML format.
102    
103 gross 379 @param filter: filter to be applied to the results
104     @type filter: L{BenchmarkFilter}
105 gross 364 @param level: level used in header <H?> tags
106     @type level: C{int}
107     @return: HTML document
108     @rtype: C{str}
109     """
110     out=""
111     if level==1: out+="<HTML><HEAD><TITLE>Benchmark: %s</TITLE></HEAD><BODY>\n"%str(self)
112     out+="<H%s>%s</H%s>\n"%(level,str(self),level)
113     if level==1:
114     m=""
115     if isinstance(self.__scale,int):
116     if self.__scale>1:
117     m=" (%s threads)"%self.__scale
118     out+="<p>platform: %s%s</p>\n"%(socket.gethostname(),m)
119     for i in range(len(self)):
120     out+="<p>\n"
121 gross 379 out+=self[i].getHTML(filter=filter,level=min(level+1,self.MAX_LEVEL))
122 gross 364 out+="<p>\n"
123     if level==1:
124 gross 390 try:
125     name=os.getlogin()
126     out+="<hr><p align=\"center\">by %s at %s</p>\n"%(name,time.strftime('%X %x %Z'))
127     except OSError:
128     out+="<hr><p align=\"center\">%s</p>\n"%(time.strftime('%X %x %Z'))
129    
130 gross 364 out+="</BODY></HTML>\n"
131     return out
132    
133    
134     class Benchmark(object):
135     """
136     runs a bunch of similar L{BenchmarkProblem}s with a bunch of L{Options}
137     """
138     def __init__(self,name=None,description=None):
139     """
140     sets up a benchmark
141    
142     @param name: name of the benchmark. If no name is given the class name is used.
143     @type name: C{str}
144     @param description: description of the benchmark.
145     @type description: C{str} or C{None}
146     """
147     super(Benchmark,self).__init__()
148     self.__options=[]
149     self.__problems=[]
150     self.__results=[]
151     self.__scale=1
152     if name==None:
153     self.__name=self.__class__.__name__
154     else:
155     self.__name=name
156     self.__description=description
157    
158     def __str__(self):
159     """
160     returns the name of the benchmark suite
161    
162     @return: name
163     @rtype: C{str}
164     """
165     return self.__name
166    
167     def addProblem(self,problem):
168     """
169     adds a problem to the benchmark
170    
171     @param problem: adds a new problem to the bechmark
172     @type problem: L{BenchmarkProblem}
173     """
174     self.__problems.append(problem)
175    
176     def addOptions(self,Options):
177     """
178     adds a options to the benchmark
179    
180     @param options: adds a new option to the bechmark
181     @type problem: L{Options}
182     """
183     self.__options.append(Options)
184    
185     def run(self,scale=1):
186     """
187     runs all problems with all options.
188    
189    
190     @param scale: defines the number of (OpenMP) threads to be used. If scale is a scalar all benchmarks
191     are run with scale number of threads. If scale is a C{list}, the p-th problem in each of the benchmarks
192 gross 387 in the suite is run with scale[p] threads. If scale[p]<1 teh p-th problem is omitted.
193 gross 364 @type scale: C{int} or C{list} of C{int}s.
194     """
195     if isinstance(scale,list):
196 gross 386 c_max=min(len(scale),len(self.__problems))
197     else:
198     c_max=len(self.__problems)
199 gross 379 self.__filter=filter
200 gross 364 self.__scale=scale
201     self.__results=[]
202 gross 386 for c in range(c_max):
203     r=self.__problems[c]
204 gross 364 if isinstance(scale,list):
205     s=scale[c]
206     else:
207     s=scale
208     row=[]
209 gross 387 if s>0:
210     for p in self.__options:
211 gross 393 setNumberOfThreads(s)
212 gross 387 row.append(r.run(p))
213 gross 364 self.__results.append(row)
214 gross 379 def getHTML(self,filter,level=1):
215 gross 364 """
216     returns the results of the last benchmark run in HTML format.
217    
218 gross 379 @param filter: filter to be applied to the results
219     @type filter: L{BenchmarkFilter}
220 gross 364 @param level: level used in header <H?> tags
221     @type level: C{int}
222     @return: HTML document
223     @rtype: C{str}
224     """
225     out=""
226     if level==1: out+="<HTML><HEAD><TITLE>Benchmark: %s</TITLE></HEAD><BODY>\n"%str(self)
227     out+="<H%s>%s</H%s>\n"%(level,str(self),level)
228     if level==1:
229     m=""
230     if isinstance(self.__scale,int):
231     if self.__scale>1:
232     m=" (%s threads)"%self.__scale
233     out+="<p>platform: %s%s</p>\n"%(socket.gethostname(),m)
234     if self.__description: out+="<p>%s</p>\n"%str(self.__description)
235     if len(self.__problems)>0:
236     out+="<TABLE ALIGN=\"center\" BORDER=3 CELLPADDING=5 CELLSPACING=1>\n"
237     h1_seg=""
238 gross 379 rn=filter.getResultNames()
239 gross 364 if len(rn)==0:
240     h1_seg+="<TD></TD>"
241     else:
242     for n in rn: h1_seg+="<TD ALIGN=\"center\">%s</TD>"%n
243     h0="<TR><TH ALIGN=\"center\" ROWSPAN=2>Case</TH>"
244     h1="<TR>"
245     if isinstance(self.__scale,list): h0+="<TH ALIGN=\"center\" ROWSPAN=2>Threads</TH>"
246     for o in self.__options:
247     if len(rn)==0:
248     h0+="<TH ALIGN=\"center\">%s</TH>"%str(o)
249     elif len(rn)==1:
250     h0+="<TH ALIGN=\"center\">%s</TH>"%str(o)
251     empty_h1=False
252     else:
253     h0+="<TH ALIGN=\"center\" COLSPAN=%s>%s</TH>"%(len(rn),str(o))
254     h1+=h1_seg
255     out+=h0+"</TR>\n"+h1+"</TR>\n"
256     c=0
257     for r in range(len(self.__results)):
258     out+="<TR><TH ALIGN=\"right\">%s</TH>"%str(self.__problems[r])
259     if isinstance(self.__scale,list): out+="<TD ALIGN=\"right\">%s</TD>"%self.__scale[c]
260 gross 385 for col in self.__results[r]:
261     for e in filter(col): out+="<TD ALIGN=\"right\">%s</TD>"%e
262 gross 364 out+="</TR>\n"
263 gross 385 c+=1
264 gross 364 out+="</TABLE>"
265     if level==1:
266     out+="<hr><p align=\"center\">by %s at %s</p>\n"%(os.getlogin(),time.strftime('%X %x %Z'))
267     out+="</BODY></HTML>\n"
268     return out
269    
270     class BenchmarkProblem(object):
271     """
272     something that can be run and returns a list of characteristics such as timing, Mflops, error, etc.
273     """
274     def __init__(self,name=None):
275     """
276     sets up a benchmark problem
277    
278     @param name: name of the problem. If no name is given the class name is used.
279     @type name: C{str}
280     """
281     super(BenchmarkProblem,self).__init__()
282     if name==None:
283     self.__name=self.__class__.__name__
284     else:
285     self.__name=name
286    
287    
288     def __str__(self):
289     """
290     returns the name of the benchmark suite
291    
292     @return: name
293     @rtype: C{str}
294     """
295     return self.__name
296    
297     def run(self,options=None):
298     """
299     runs the problem and returns a list of run characteristics
300    
301    
302     @param options: the options that are used for the run. Note that the number of OpenMP threads is controlled
303     by the L{Benchmark} the problem is run in.
304     @type options: L{Options}
305 gross 379 @return: run characteristics
306     @rtype: any type that can be read by the L{BenchmarkFilter} applied to it.
307 gross 364 @remark: this function has to overwritten by a particular problem
308     """
309     raise NotImplementedError
310     return []
311    
312 gross 379 class BenchmarkFilter(object):
313     """
314     object to filter the characteristcs returned by Bechmark runs.
315    
316     """
317     def __init__(self):
318     """
319     sets up a filter
320     """
321     pass
322    
323    
324     def getResultNames(self):
325     """
326     return the names of the results produced when run() is called.
327    
328     @return: names the list of the names to be used when the results of the run() call are printed
329     @rtype: C{list} of C{str}
330     @remark: this function has to overwritten by a particular problem
331     """
332     raise NotImplementedError
333     return []
334    
335     def __call__(self,result):
336     """
337     filters out values results returned as characteristcs of a problem run
338    
339     @param result: values to be filtered
340     @type result: any type that is produced by the L{BenchmarkProblem} it is applied to
341     @return: a list of strings selected from result
342     @rtype: C{list} of C{str}
343     @remark: this function has to overwritten by a particular problem
344     """
345     raise NotImplementedError
346     return []
347    
348    
349 gross 364 class Options(object):
350     """
351     defines a set of options to be used to run a L{BenchmarkProblem}
352     """
353     def __init__(self,name=None):
354     """
355     sets up the options
356    
357     @param name: name of the option. If no name is given the class name is used.
358     @type name: C{str}
359     """
360     super(Options,self).__init__()
361     if name==None:
362 gross 385 self.__name=self.__class__.__name__
363 gross 364 else:
364     self.__name=name
365     def __str__(self):
366     """
367     returns the name of the benchmark suite
368    
369     @return: name
370     @rtype: C{str}
371     """
372     return self.__name
373    
374     if __name__=="__main__":
375    
376     class OptionsTest1(Options):
377     pass
378     class OptionsTest2(Options):
379     pass
380    
381 gross 379 class BenchmarkProblemTest1(BenchmarkProblem):
382 gross 364 def __init__(self):
383     super(BenchmarkProblemTest1,self).__init__(name="TEST1")
384     def run(self,options=None):
385     import time
386     return time.time(),"A"
387    
388 gross 379 class BenchmarkProblemTest2(BenchmarkProblem):
389 gross 364 def __init__(self):
390     super(BenchmarkProblemTest2,self).__init__(name="TEST2")
391     def run(self,options=None):
392     import time
393     return -time.time(),"B"
394    
395 gross 379 class SimpleFilter(BenchmarkFilter):
396     def getResultNames(self):
397     return ["r0","r1"]
398     def __call__(self,result):
399     return [str(result[0]),str(result[1])]
400    
401 gross 364 bm=Benchmark("Example")
402     bm.addProblem(BenchmarkProblemTest1())
403     bm.addProblem(BenchmarkProblemTest2())
404     bm.addOptions(OptionsTest1())
405     bm.addOptions(OptionsTest2())
406    
407     bms=BenchmarkSuite("A Test")
408     bms.addBenchmark(bm)
409    
410     bms.run()
411 gross 379 print bms.getHTML(filter=SimpleFilter())
412 gross 364
413     bms.run(scale=4)
414 gross 379 print bms.getHTML(filter=SimpleFilter())
415 gross 364
416     bms.run(scale=[1,2])
417 gross 379 print bms.getHTML(filter=SimpleFilter())

  ViewVC Help
Powered by ViewVC 1.1.26