.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcs_profiling_event.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXcs_profiling_event (base class)
    ! cs_profiling_event (base class)
    see: cs_profiling_event (base class); NXcs_profiling_event

.. _NXcs_profiling_event:

====================
NXcs_profiling_event
====================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Computer science description of a profiling event.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

  **n_processes**: Number of processes.

**Groups cited**:
  none

**Structure**:

  .. _/NXcs_profiling_event/start_time-field:

  .. index:: start_time (field)

  **start_time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>`

    ISO 8601 time code with local time zone offset to UTC information
    included when the event tracking started.

  .. _/NXcs_profiling_event/end_time-field:

  .. index:: end_time (field)

  **end_time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>`

    ISO 8601 time code with local time zone offset to UTC information
    included when the event tracking ended.

  .. _/NXcs_profiling_event/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Free-text description what was monitored/executed during the event.

  .. _/NXcs_profiling_event/elapsed_time-field:

  .. index:: elapsed_time (field)

  **elapsed_time**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TIME <NX_TIME>`}

    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.

  .. _/NXcs_profiling_event/number_of_processes-field:

  .. index:: number_of_processes (field)

  **number_of_processes**: (optional) :ref:`NX_POSINT <NX_POSINT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Number of processes used (max) during the execution of this event.

  .. _/NXcs_profiling_event/number_of_threads-field:

  .. index:: number_of_threads (field)

  **number_of_threads**: (optional) :ref:`NX_POSINT <NX_POSINT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Number of threads used (max) during the execution of this event.

  .. _/NXcs_profiling_event/number_of_gpus-field:

  .. index:: number_of_gpus (field)

  **number_of_gpus**: (optional) :ref:`NX_POSINT <NX_POSINT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Number of GPUs used (max) during the execution of this event.

  .. _/NXcs_profiling_event/max_virtual_memory_snapshot-field:

  .. index:: max_virtual_memory_snapshot (field)

  **max_virtual_memory_snapshot**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_processes]) {units=\ :ref:`NX_ANY <NX_ANY>`}

    Maximum amount of virtual memory allocated per process during the event.

  .. _/NXcs_profiling_event/max_resident_memory_snapshot-field:

  .. index:: max_resident_memory_snapshot (field)

  **max_resident_memory_snapshot**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_processes]) {units=\ :ref:`NX_ANY <NX_ANY>`}

    Maximum amount of resident memory allocated per process during the event.


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXcs_profiling_event/description-field </NXcs_profiling_event/description-field>`
* :ref:`/NXcs_profiling_event/elapsed_time-field </NXcs_profiling_event/elapsed_time-field>`
* :ref:`/NXcs_profiling_event/end_time-field </NXcs_profiling_event/end_time-field>`
* :ref:`/NXcs_profiling_event/max_resident_memory_snapshot-field </NXcs_profiling_event/max_resident_memory_snapshot-field>`
* :ref:`/NXcs_profiling_event/max_virtual_memory_snapshot-field </NXcs_profiling_event/max_virtual_memory_snapshot-field>`
* :ref:`/NXcs_profiling_event/number_of_gpus-field </NXcs_profiling_event/number_of_gpus-field>`
* :ref:`/NXcs_profiling_event/number_of_processes-field </NXcs_profiling_event/number_of_processes-field>`
* :ref:`/NXcs_profiling_event/number_of_threads-field </NXcs_profiling_event/number_of_threads-field>`
* :ref:`/NXcs_profiling_event/start_time-field </NXcs_profiling_event/start_time-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXcs_profiling_event.nxdl.xml