/
NXcs_profiling_event.nxdl.xml
95 lines (95 loc) · 3.85 KB
/
NXcs_profiling_event.nxdl.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
<!--
# NeXus - Neutron and X-ray Common Data Format
#
# Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC)
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# For further information, see http://www.nexusformat.org
-->
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" name="NXcs_profiling_event" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<symbols>
<doc>
The symbols used in the schema to specify e.g. dimensions of arrays.
</doc>
<symbol name="n_processes">
<doc>
Number of processes.
</doc>
</symbol>
</symbols>
<doc>
Computer science description of a profiling event.
</doc>
<field name="start_time" type="NX_DATE_TIME">
<doc>
ISO 8601 time code with local time zone offset to UTC information
included when the event tracking started.
</doc>
</field>
<field name="end_time" type="NX_DATE_TIME">
<doc>
ISO 8601 time code with local time zone offset to UTC information
included when the event tracking ended.
</doc>
</field>
<field name="description">
<doc>
Free-text description what was monitored/executed during the event.
</doc>
</field>
<field name="elapsed_time" type="NX_NUMBER" units="NX_TIME">
<doc>
Wall-clock time how long the event took. This may be in principle
end_time minus start_time; however usage of eventually more precise timers
may warrant to use a finer temporal discretization,
and thus demand a more precise record of the wall-clock time.
Elapsed time may contain time portions where resources were idling.
</doc>
</field>
<field name="number_of_processes" type="NX_POSINT" units="NX_UNITLESS">
<doc>
Number of processes used (max) during the execution of this event.
</doc>
</field>
<field name="number_of_threads" type="NX_POSINT" units="NX_UNITLESS">
<doc>
Number of threads used (max) during the execution of this event.
</doc>
</field>
<field name="number_of_gpus" type="NX_POSINT" units="NX_UNITLESS">
<doc>
Number of GPUs used (max) during the execution of this event.
</doc>
</field>
<field name="max_virtual_memory_snapshot" type="NX_NUMBER" units="NX_ANY">
<doc>
Maximum amount of virtual memory allocated per process during the event.
</doc>
<dimensions rank="1">
<dim index="1" value="n_processes"/>
</dimensions>
</field>
<field name="max_resident_memory_snapshot" type="NX_NUMBER" units="NX_ANY">
<doc>
Maximum amount of resident memory allocated per process during the event.
</doc>
<dimensions rank="1">
<dim index="1" value="n_processes"/>
</dimensions>
</field>
</definition>