1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# Introduction
A typical example on profiling with Yappi, includes at least 3 lines of
code:
```python
import yappi
def a():
for i in range(10000000): pass
yappi.start()
a()
yappi.get_func_stats().print_all()
yappi.get_thread_stats().print_all()
```
And the output of running above script:
```
Clock type: cpu
Ordered by: totaltime, desc
name ncall tsub ttot tavg
deneme.py:35 a 1 0.296402 0.296402 0.296402
name tid ttot scnt
_MainThread 6016 0.296402 1
```
**Let's inspect the results in detail.**
---
The first line:
```
Clock type: cpu
```
indicates the profiling timing stats shown are retrieved using the CPU clock.
That means the actual CPU time spent in the function is shown.
Yappi provides two modes of operation: CPU and Wall time profiling. You can change the
setting by a call to [`yappi.set_clock_type()`](./api.md#set_clock_typetype).
Read [ClockTypes](./clock_types.md) for more.
---
Second is:
```
Ordered by: totaltime, desc
```
This shows the sort order and sort key of the
shown profiling stats. You can see the valid values for this here - [`YFuncStats.sort()`](./api.md#sortsort_type-sort_orderdesc).
---
Now we actually see the statistic of the function call `a()`:
```
name ncall tsub ttot tavg
deneme.py:35 a 1 0.296402 0.296402 0.296402
```
Here is what each of these mean -
| *Title* | *Description* |
|---------|----------------------------------------------------------------------|
| name | the full unique name of the called function. |
| ncall | How many times this function is called. |
| tsub | How much time this function has spent in total, subcalls excluded. |
| ttot | How much time this function has spent in total, subcalls included. |
| tavg | How much time this function has spent in average, subcalls included. |
---
The next lines shows the thread stats:
```
name tid ttot scnt
_MainThread 6016 0.296402 1
```
Here is what each of these mean -
| *Title* | *Description* |
|---------|---------------------------------------------------------------------------------------------------|
| name | The class name of the Thread. (This is the name of the class inherits the threading.Thread class) |
| tid | The thread id. |
| ttot | How much time this thread has spent in total. |
| scnt | How many times this thread is scheduled. |
|
