Skip to content

Commit f10fe03

Browse files
committed
Updated provDB schema docs
1 parent b953ca2 commit f10fe03

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

sphinx/source/io_schema/provdb_schema.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ Function execution "events" in Chimbuko are labeled by a unique (for each proces
6060
| **"io_step"**: *IO step index*,
6161
| **"io_step_tstart"**: *Time of start of IO step*,
6262
| **"io_step_tend"**: *Time of end of IO step*,
63-
| **"outlier_score"**: *The anomaly score of the execution (algorithm dependent)*,
63+
| **"outlier_score"**: *The anomaly score of the execution reflecting how unlikely the event is (algorithm dependent, larger is more anomalous)*,
64+
| **"outlier_severity"**: *The severity of the anomaly, reflecting how important the anomaly was*,
6465
| **"event_window"**: *Capture of function executions and MPI comms events occuring in window around anomaly on same thread (object)*
6566
| {
6667
| **"exec_window"**: *The function executions in the window arranged in order of their entry time (array)*
@@ -110,6 +111,13 @@ For the SSTD (original) algorithm, the **algo_params** field has the following f
110111
| **"stddev"**: *standard deviation of distribution*
111112
| }
112113
114+
For the HBOS and COPOD algorithms, the **algo_params** field has the following format:
115+
116+
| {
117+
| **"Histogram Bin Counts"** : *the height of the histogram bin*,
118+
| **"Histogram Bin Edges"** : *the edges of the bins starting with the lower edge of bin 0 followed by the upper edges of bins 0..N*
119+
| }
120+
113121

114122
---------
115123

@@ -170,7 +178,7 @@ Metadata are stored in the metadata collection in the following JSON schema:
170178
Note that the **tid** (thread index) for metadata is usually 0, apart from for metadata associated with a GPU context/device/stream, for which the index is the virtual thread index assigned by Tau to the context/device/stream.
171179

172180
Global database
173-
-------------
181+
---------------
174182

175183
Below we describe the JSON schema for the **func_stats** and **counter_stats** collections of the **global database** component of the provenance database.
176184

0 commit comments

Comments
 (0)