perun
v0.8.0
Contents:
Quick Start
Installation
Usage
Configuration
Data
API Reference
perun
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__allow_reinitialization (perun.util.Singleton attribute)
__call__() (perun.util.Singleton method)
__del__() (perun.core.Perun method)
__repr__() (perun.data_model.data.MetricType method)
(perun.monitoring.application.Application method)
__str__() (perun.data_model.data.LocalRegions method)
(perun.data_model.data.MetricType method)
(perun.data_model.measurement_type.Magnitude method)
(perun.data_model.measurement_type.Unit method)
(perun.monitoring.application.Application method)
__version__ (in module perun)
_addMetric() (in module perun.io.hdf5)
_addMetricMetadata() (in module perun.io.hdf5)
_addNode() (in module perun.io.hdf5)
_addRawData() (in module perun.io.hdf5)
_addRegion() (in module perun.io.hdf5)
_addRegions() (in module perun.io.hdf5)
_app (perun.monitoring.application.Application attribute)
(perun.monitoring.monitor.PerunMonitor attribute)
_args (perun.monitoring.application.Application attribute)
_backends (perun.core.Perun attribute)
(perun.monitoring.monitor.PerunMonitor attribute)
_cleanup() (perun.monitoring.application.Application method)
_close_backends() (perun.core.Perun method)
_comm (perun.core.Perun attribute)
(perun.monitoring.monitor.PerunMonitor attribute)
_config (perun.monitoring.monitor.PerunMonitor attribute)
_default_config (in module perun.configuration)
_enabled (perun.comm.Comm attribute)
_export_multirun() (perun.core.Perun method)
_g_assigned_sensors (perun.core.Perun attribute)
_g_available_sensors (perun.core.Perun attribute)
_get_arg_parser() (in module perun.api.cli)
_getCallback() (perun.backend.psutil.PSUTILBackend method)
_getClockCallback() (perun.backend.nvml.NVMLBackend method)
_getClockSensor() (perun.backend.nvml.NVMLBackend method)
_getMemCallback() (perun.backend.rocmsmi.ROCMBackend method)
_getMemorySensor() (perun.backend.nvml.NVMLBackend method)
_getMemSensor() (perun.backend.rocmsmi.ROCMBackend method)
_getPowerCallback() (perun.backend.nvml.NVMLBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
_getPowerSensor() (perun.backend.nvml.NVMLBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
_getUsedMemCallback() (perun.backend.nvml.NVMLBackend method)
_handle_failed_run() (perun.monitoring.monitor.PerunMonitor method)
_host_rank (perun.core.Perun attribute)
_hostname (perun.core.Perun attribute)
_initialized (perun.comm.Comm attribute)
_instances (perun.util.Singleton attribute)
_is_binary (perun.monitoring.application.Application attribute)
_kwargs (perun.monitoring.application.Application attribute)
_l_assigned_sensors (perun.core.Perun attribute)
(perun.monitoring.monitor.PerunMonitor attribute)
_l_available_sensors (perun.core.Perun attribute)
_l_backend_metadata (perun.core.Perun attribute)
_l_host_metadata (perun.core.Perun attribute)
_mag_symbols (in module perun.data_model.measurement_type)
_metadata (perun.backend.backend.Backend attribute)
_monitor (perun.core.Perun attribute)
_monitoringLoop() (in module perun.monitoring.subprocess)
_mpi_init() (perun.comm.Comm method)
_name (perun.monitoring.application.Application attribute)
_process_multirun() (perun.core.Perun method)
_process_single_run() (perun.monitoring.monitor.PerunMonitor method)
_rank (perun.comm.Comm attribute)
_readMetric() (in module perun.io.hdf5)
_readMetricMetadata() (in module perun.io.hdf5)
_readNode() (in module perun.io.hdf5)
_readRawData() (in module perun.io.hdf5)
_readRegion() (in module perun.io.hdf5)
_readRegions() (in module perun.io.hdf5)
_regions (perun.data_model.data.LocalRegions attribute)
_reset_subprocess_handlers() (perun.monitoring.monitor.PerunMonitor method)
_rowsFromRunNode() (in module perun.io.pandas)
_run_binary_app() (perun.monitoring.monitor.PerunMonitor method)
_run_postprocess_callbacks() (perun.core.Perun method)
_run_python_app() (perun.monitoring.monitor.PerunMonitor method)
_setName() (perun.monitoring.application.Application method)
_size (perun.comm.Comm attribute)
_suffixes (in module perun.io.io)
A
Abort() (perun.comm.Comm method)
addEvent() (perun.data_model.data.LocalRegions method)
addRegionData() (perun.data_model.data.DataNode method)
addRunAndRuntimeInfoToRegion() (in module perun.processing)
agg (perun.data_model.data.Metric attribute)
AggregateType (class in perun.data_model.data)
allgather() (perun.comm.Comm method)
alt_v_md (perun.data_model.data.RawData attribute)
alt_values (perun.data_model.data.RawData attribute)
APP (perun.data_model.data.NodeType attribute)
Application (class in perun.monitoring.application)
args (perun.monitoring.application.Application property)
assignSensors() (in module perun.coordination)
availableSensors() (perun.backend.backend.Backend method)
(perun.backend.nvml.NVMLBackend method)
(perun.backend.powercap_rapl.PowercapRAPLBackend method)
(perun.backend.psutil.PSUTILBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
B
Backend (class in perun.backend.backend)
backends (perun.core.Perun property)
barrier() (perun.comm.Comm method)
bcast() (perun.comm.Comm method)
BENCH (perun.io.io.IOFormat attribute)
BYTE (perun.data_model.measurement_type.Unit attribute)
C
check_available_ranks() (perun.comm.Comm method)
cli() (in module perun.api.cli)
close() (perun.backend.backend.Backend method)
(perun.backend.nvml.NVMLBackend method)
(perun.backend.powercap_rapl.PowercapRAPLBackend method)
(perun.backend.psutil.PSUTILBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
CO2 (perun.data_model.data.MetricType attribute)
Comm (class in perun.comm)
comm (perun.core.Perun property)
config (in module perun)
(in module perun.configuration)
(perun.core.Perun attribute)
copy() (perun.data_model.data.Metric method)
(perun.data_model.measurement_type.MetricMetaData method)
CPU (perun.data_model.sensor.DeviceType attribute)
CPU_CLOCK (perun.data_model.data.MetricType attribute)
CPU_ENERGY (perun.data_model.data.MetricType attribute)
CPU_POWER (perun.data_model.data.MetricType attribute)
CPU_UTIL (perun.data_model.data.MetricType attribute)
createNode() (in module perun.monitoring.subprocess)
CSV (perun.io.io.IOFormat attribute)
D
DataNode (class in perun.data_model.data)
dataType (perun.data_model.sensor.Sensor attribute)
default() (perun.io.json.NumpyEncoder method)
description (perun.backend.backend.Backend attribute)
(perun.backend.nvml.NVMLBackend attribute)
(perun.backend.powercap_rapl.PowercapRAPLBackend attribute)
(perun.backend.psutil.PSUTILBackend attribute)
(perun.backend.rocmsmi.ROCMBackend attribute)
DEVICE_GROUP (perun.data_model.data.NodeType attribute)
devices (perun.backend.backend.Backend attribute)
DeviceType (class in perun.data_model.sensor)
deviceType (perun.data_model.data.DataNode attribute)
DIR_RGX (in module perun.backend.powercap_rapl)
DISK (perun.data_model.sensor.DeviceType attribute)
DISK_READ (perun.data_model.data.MetricType attribute)
DISK_WRITE (perun.data_model.data.MetricType attribute)
DRAM_ENERGY (perun.data_model.data.MetricType attribute)
DRAM_MEM (perun.data_model.data.MetricType attribute)
DRAM_POWER (perun.data_model.data.MetricType attribute)
dtype (perun.data_model.measurement_type.MetricMetaData attribute)
E
ENERGY (perun.data_model.data.MetricType attribute)
export() (in module perun.api.cli)
export_to() (perun.core.Perun method)
exportBench() (in module perun.io.bench)
exportCSV() (in module perun.io.pandas)
exportHDF5() (in module perun.io.hdf5)
exportJson() (in module perun.io.json)
exportPickle() (in module perun.io.pickle)
exportTo() (in module perun.io.io)
F
FAN (perun.data_model.sensor.DeviceType attribute)
FILE_NOT_FOUND (perun.monitoring.monitor.MonitorStatus attribute)
fill (perun.data_model.measurement_type.MetricMetaData attribute)
filter_sensors() (in module perun.util)
fromDict() (perun.data_model.data.DataNode class method)
(perun.data_model.data.Metric class method)
(perun.data_model.data.RawData class method)
(perun.data_model.data.Region class method)
(perun.data_model.data.Stats class method)
(perun.data_model.measurement_type.MetricMetaData class method)
fromMetrics() (perun.data_model.data.Stats class method)
fromString() (perun.data_model.data.MetricType method)
fromSuffix() (perun.io.io.IOFormat class method)
fromSymbol() (perun.data_model.measurement_type.Magnitude class method)
G
g_assigned_sensors (perun.core.Perun property)
g_available_sensors (perun.core.Perun property)
gather() (perun.comm.Comm method)
gather_from_ranks() (perun.comm.Comm method)
Get_rank() (perun.comm.Comm method)
Get_size() (perun.comm.Comm method)
getBackendMetadata() (in module perun.backend.util)
getHostMetadata() (in module perun.backend.util)
getHostRankDict() (in module perun.coordination)
getInterpolatedValues() (in module perun.processing)
getRunId() (in module perun.util)
getSensors() (perun.backend.backend.Backend method)
(perun.backend.nvml.NVMLBackend method)
(perun.backend.powercap_rapl.PowercapRAPLBackend method)
(perun.backend.psutil.PSUTILBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
getTFactorMag() (in module perun.io.util)
GIGA (perun.data_model.measurement_type.Magnitude attribute)
globalConfigPath (in module perun.configuration)
GPU (perun.data_model.sensor.DeviceType attribute)
GPU_CLOCK (perun.data_model.data.MetricType attribute)
GPU_ENERGY (perun.data_model.data.MetricType attribute)
GPU_MEM (perun.data_model.data.MetricType attribute)
GPU_POWER (perun.data_model.data.MetricType attribute)
GPU_UTIL (perun.data_model.data.MetricType attribute)
GRAM (perun.data_model.measurement_type.Unit attribute)
H
HDF5 (perun.io.io.IOFormat attribute)
host_rank (perun.core.Perun property)
hostname (perun.core.Perun property)
HZ (perun.data_model.measurement_type.Unit attribute)
I
id (perun.backend.backend.Backend attribute)
(perun.backend.nvml.NVMLBackend attribute)
(perun.backend.powercap_rapl.PowercapRAPLBackend attribute)
(perun.backend.psutil.PSUTILBackend attribute)
(perun.backend.rocmsmi.ROCMBackend attribute)
(perun.data_model.data.DataNode attribute)
(perun.data_model.data.Region attribute)
(perun.data_model.sensor.Sensor attribute)
import_from() (perun.core.Perun method)
importFrom() (in module perun.io.io)
importHDF5() (in module perun.io.hdf5)
importJson() (in module perun.io.json)
importPickle() (in module perun.io.pickle)
increaseIdCounter() (in module perun.util)
init_logging() (in module perun)
(in module perun.logging)
IOFormat (class in perun.io.io)
is_binary (perun.monitoring.application.Application property)
isEmpty() (perun.data_model.data.LocalRegions method)
J
JOULE (perun.data_model.measurement_type.Unit attribute)
JSON (perun.io.io.IOFormat attribute)
K
KILO (perun.data_model.measurement_type.Magnitude attribute)
kwargs (perun.monitoring.application.Application property)
L
l_assigned_sensors (perun.core.Perun property)
l_available_sensors (perun.core.Perun property)
l_backend_metadata (perun.core.Perun property)
l_host_metadata (perun.core.Perun property)
localConfigPath (in module perun.configuration)
LocalRegions (class in perun.data_model.data)
log (in module perun)
(in module perun.api.cli)
(in module perun.api.decorator)
(in module perun.backend.backend)
(in module perun.backend.nvml)
(in module perun.backend.powercap_rapl)
(in module perun.backend.psutil)
(in module perun.backend.rocmsmi)
(in module perun.backend.util)
(in module perun.comm)
(in module perun.configuration)
(in module perun.coordination)
(in module perun.core)
(in module perun.data_model.data)
(in module perun.data_model.measurement_type)
(in module perun.io.bench)
(in module perun.io.io)
(in module perun.io.text_report)
(in module perun.monitoring.application)
(in module perun.monitoring.monitor)
(in module perun.monitoring.subprocess)
(in module perun.processing)
(in module perun.util)
M
mag (perun.data_model.measurement_type.MetricMetaData attribute)
Magnitude (class in perun.data_model.measurement_type)
mark_event() (perun.core.Perun method)
matchesOneOf() (in module perun.util)
MAX (perun.data_model.data.AggregateType attribute)
max (perun.data_model.data.Stats attribute)
(perun.data_model.measurement_type.MetricMetaData attribute)
MEAN (perun.data_model.data.AggregateType attribute)
mean (perun.data_model.data.Stats attribute)
measureCallback (perun.data_model.sensor.Sensor attribute)
MEGA (perun.data_model.measurement_type.Magnitude attribute)
metadata (perun.backend.backend.Backend property)
(perun.data_model.data.DataNode attribute)
(perun.data_model.sensor.Sensor attribute)
metadata() (in module perun.api.cli)
Metric (class in perun.data_model.data)
metric_md (perun.data_model.data.Metric attribute)
(perun.data_model.data.Stats attribute)
MetricMetaData (class in perun.data_model.measurement_type)
metrics (perun.data_model.data.DataNode attribute)
(perun.data_model.data.Region attribute)
MetricType (class in perun.data_model.data)
MICRO (perun.data_model.measurement_type.Magnitude attribute)
MILI (perun.data_model.measurement_type.Magnitude attribute)
MIN (perun.data_model.data.AggregateType attribute)
min (perun.data_model.data.Stats attribute)
(perun.data_model.measurement_type.MetricMetaData attribute)
module
perun
perun.__main__
perun.api
perun.api.cli
perun.api.decorator
perun.backend
perun.backend.backend
perun.backend.nvml
perun.backend.powercap_rapl
perun.backend.psutil
perun.backend.rocmsmi
perun.backend.util
perun.comm
perun.configuration
perun.coordination
perun.core
perun.data_model
perun.data_model.data
perun.data_model.measurement_type
perun.data_model.sensor
perun.io
perun.io.bench
perun.io.hdf5
perun.io.io
perun.io.json
perun.io.pandas
perun.io.pickle
perun.io.text_report
perun.io.util
perun.logging
perun.monitoring
perun.monitoring.application
perun.monitoring.monitor
perun.monitoring.subprocess
perun.processing
perun.util
MONEY (perun.data_model.data.MetricType attribute)
monitor() (in module perun)
(in module perun.api.cli)
(in module perun.api.decorator)
monitor_application() (perun.core.Perun method)
MonitorStatus (class in perun.monitoring.monitor)
MPI_ERROR (perun.monitoring.monitor.MonitorStatus attribute)
MULTI_RUN (perun.data_model.data.NodeType attribute)
N
N_RUNS (perun.data_model.data.MetricType attribute)
name (perun.backend.backend.Backend attribute)
(perun.backend.nvml.NVMLBackend attribute)
(perun.backend.powercap_rapl.PowercapRAPLBackend attribute)
(perun.backend.psutil.PSUTILBackend attribute)
(perun.backend.rocmsmi.ROCMBackend attribute)
(perun.monitoring.application.Application property)
NANO (perun.data_model.measurement_type.Magnitude attribute)
NET (perun.data_model.sensor.DeviceType attribute)
NET_READ (perun.data_model.data.MetricType attribute)
NET_WRITE (perun.data_model.data.MetricType attribute)
NODE (perun.data_model.data.NodeType attribute)
(perun.data_model.sensor.DeviceType attribute)
nodes (perun.data_model.data.DataNode attribute)
NodeType (class in perun.data_model.data)
NumpyEncoder (class in perun.io.json)
NVMLBackend (class in perun.backend.nvml)
O
ONE (perun.data_model.measurement_type.Magnitude attribute)
OTHER (perun.data_model.sensor.DeviceType attribute)
OTHER_ENERGY (perun.data_model.data.MetricType attribute)
OTHER_MEM (perun.data_model.data.MetricType attribute)
OTHER_POWER (perun.data_model.data.MetricType attribute)
OTHER_UTIL (perun.data_model.data.MetricType attribute)
P
PERCENT (perun.data_model.measurement_type.Unit attribute)
perun
module
Perun (class in perun.core)
perun() (in module perun)
(in module perun.api.decorator)
perun.__main__
module
perun.api
module
perun.api.cli
module
perun.api.decorator
module
perun.backend
module
perun.backend.backend
module
perun.backend.nvml
module
perun.backend.powercap_rapl
module
perun.backend.psutil
module
perun.backend.rocmsmi
module
perun.backend.util
module
perun.comm
module
perun.configuration
module
perun.coordination
module
perun.core
module
perun.data_model
module
perun.data_model.data
module
perun.data_model.measurement_type
module
perun.data_model.sensor
module
perun.io
module
perun.io.bench
module
perun.io.hdf5
module
perun.io.io
module
perun.io.json
module
perun.io.pandas
module
perun.io.pickle
module
perun.io.text_report
module
perun.io.util
module
perun.logging
module
perun.monitoring
module
perun.monitoring.application
module
perun.monitoring.monitor
module
perun.monitoring.subprocess
module
perun.processing
module
perun.util
module
PERUN_ERROR (perun.monitoring.monitor.MonitorStatus attribute)
PerunMonitor (class in perun.monitoring.monitor)
perunSubprocess() (in module perun.monitoring.subprocess)
PICKLE (perun.io.io.IOFormat attribute)
PICO (perun.data_model.measurement_type.Magnitude attribute)
postprocess_callbacks (perun.core.Perun attribute)
POWER (perun.data_model.data.MetricType attribute)
PowercapRAPLBackend (class in perun.backend.powercap_rapl)
prepSensors() (in module perun.monitoring.subprocess)
processDataNode() (in module perun.processing)
processed (perun.data_model.data.DataNode attribute)
(perun.data_model.data.Region attribute)
processEnergyData() (in module perun.processing)
PROCESSING (perun.monitoring.monitor.MonitorStatus attribute)
processRegionsWithSensorData() (in module perun.processing)
processSensorData() (in module perun.processing)
PSUTILBackend (class in perun.backend.psutil)
R
RACK (perun.data_model.sensor.DeviceType attribute)
RAM (perun.data_model.sensor.DeviceType attribute)
RAPL_PATH (in module perun.backend.powercap_rapl)
raw_data (perun.data_model.data.DataNode attribute)
(perun.data_model.data.Region attribute)
RawData (class in perun.data_model.data)
read() (perun.data_model.sensor.Sensor method)
read_custom_config() (in module perun.configuration)
read_environ() (in module perun.configuration)
Region (class in perun.data_model.data)
regionMetrics (in module perun.io.text_report)
regions (perun.data_model.data.DataNode attribute)
register_callback() (in module perun)
(in module perun.api.decorator)
ROCMBackend (class in perun.backend.rocmsmi)
RUN (perun.data_model.data.NodeType attribute)
run() (perun.monitoring.application.Application method)
run_application() (perun.monitoring.monitor.PerunMonitor method)
RUNNING (perun.monitoring.monitor.MonitorStatus attribute)
runs_per_rank (perun.data_model.data.Region attribute)
RUNTIME (perun.data_model.data.MetricType attribute)
S
sanitize_config() (in module perun.configuration)
save_to_config() (in module perun.configuration)
SCALAR (perun.data_model.measurement_type.Unit attribute)
SCRIPT_ERROR (perun.monitoring.monitor.MonitorStatus attribute)
SECOND (perun.data_model.measurement_type.Unit attribute)
Sensor (class in perun.data_model.sensor)
SENSOR (perun.data_model.data.NodeType attribute)
sensors() (in module perun.api.cli)
sensors_table() (in module perun.io.text_report)
SETUP (perun.monitoring.monitor.MonitorStatus attribute)
setup() (perun.backend.backend.Backend method)
(perun.backend.nvml.NVMLBackend method)
(perun.backend.powercap_rapl.PowercapRAPLBackend method)
(perun.backend.psutil.PSUTILBackend method)
(perun.backend.rocmsmi.ROCMBackend method)
showconf() (in module perun.api.cli)
Singleton (class in perun.util)
Stats (class in perun.data_model.data)
status (perun.monitoring.monitor.PerunMonitor attribute)
std (perun.data_model.data.Stats attribute)
SUBDIR_RGX (in module perun.backend.powercap_rapl)
SUCCESS (perun.monitoring.monitor.MonitorStatus attribute)
suffix (perun.io.io.IOFormat property)
SUM (perun.data_model.data.AggregateType attribute)
sum (perun.data_model.data.Stats attribute)
symbol (perun.data_model.measurement_type.Magnitude property)
(perun.data_model.measurement_type.Unit property)
T
t_md (perun.data_model.data.RawData attribute)
tableMetrics (in module perun.io.text_report)
TERA (perun.data_model.measurement_type.Magnitude attribute)
TEXT (perun.io.io.IOFormat attribute)
textReport() (in module perun.io.text_report)
timesteps (perun.data_model.data.RawData attribute)
toDict() (perun.data_model.data.DataNode method)
(perun.data_model.data.Region method)
(perun.data_model.sensor.Sensor method)
type (perun.data_model.data.DataNode attribute)
(perun.data_model.data.Metric attribute)
(perun.data_model.data.Stats attribute)
(perun.data_model.sensor.Sensor attribute)
U
Unit (class in perun.data_model.measurement_type)
unit (perun.data_model.measurement_type.MetricMetaData attribute)
V
v_md (perun.data_model.data.RawData attribute)
value (perun.data_model.data.Metric attribute)
(perun.data_model.data.Stats property)
value2MeanStdStr() (in module perun.io.util)
value2ValueUnitStr() (in module perun.io.util)
values (perun.data_model.data.RawData attribute)
W
warmup_round (perun.core.Perun attribute)
WATT (perun.data_model.measurement_type.Unit attribute)