Skip to content

Commit 93cf63c

Browse files
committed
Added reference to viz documentation in usage documentation
Added several missing headers to API documentation
1 parent e57f7f0 commit 93cf63c

File tree

2 files changed

+64
-3
lines changed

2 files changed

+64
-3
lines changed

sphinx/source/api/api_code.rst

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,13 @@ ADNetClient
8686
:project: api
8787
:path: ../../include/chimbuko/ad//ADNetClient.hpp
8888

89+
ADNormalEventProvenance
90+
-----------------------
91+
92+
.. doxygenfile:: ADNormalEventProvenance.hpp
93+
:project: api
94+
:path: ../../include/chimbuko/ad//ADNormalEventProvenance.hp
95+
8996
ADOutlier
9097
---------
9198

@@ -114,13 +121,14 @@ ADProvenanceDBengine
114121
:project: api
115122
:path: ../../include/chimbuko/ad//ADProvenanceDBengine.hpp
116123

117-
AnomalyStat
124+
AnomalyData
118125
-----------
119126

120-
.. doxygenfile:: AnomalyStat.hpp
127+
.. doxygenfile:: AnomalyData.hpp
121128
:project: api
122-
:path: ../../include/chimbuko/ad//AnomalyStat.hpp
129+
:path: ../../include/chimbuko/ad//AnomalyData.hpp
123130

131+
124132
ExecData
125133
--------
126134

@@ -161,6 +169,14 @@ Parameter Server
161169

162170
The parameter server runs on the head node and aggregates function anomaly and counter statistics for visualization. Aggregated statistics for function executions are also maintained and synchronized back to the AD instances such that the anomaly detection algorithm uses the most complete statistics to identify anomalies.
163171

172+
AnomalyStat
173+
-----------
174+
175+
.. doxygenfile:: AnomalyStat.hpp
176+
:project: api
177+
:path: ../../include/chimbuko/pserver/AnomalyStat.hpp
178+
179+
164180
global_anomaly_stats
165181
--------------------
166182

@@ -182,6 +198,13 @@ PSglobalFunctionIndexMap
182198
:project: api
183199
:path: ../../include/chimbuko/pserver/PSglobalFunctionIndexMap.hpp
184200

201+
PSProvenanceDBclient
202+
--------------------
203+
204+
.. doxygenfile:: PSProvenanceDBclient.hpp
205+
:project: api
206+
:path: ../../include/chimbuko/pserver/PSProvenanceDBclient.hpp
207+
185208
PSstatSender
186209
------------
187210

@@ -216,6 +239,14 @@ ZMQNet
216239
:project: api
217240
:path: ../../../include/chimbuko/net/zmq_net.hpp
218241

242+
ZMQMENet
243+
--------
244+
245+
.. doxygenfile:: zmqme_net.hpp
246+
:project: api
247+
:path: ../../include/chimbuko/net/zmqme_net.hpp
248+
249+
219250
Message
220251
~~~~~~~
221252

@@ -263,13 +294,34 @@ DispatchQueue
263294
:project: api
264295
:path: ../../include/chimbuko/util//DispatchQueue.hpp
265296

297+
error
298+
-----
299+
300+
.. doxygenfile:: error.hpp
301+
:project: api
302+
:path: ../../include/chimbuko/util//error.hpp
303+
266304
hash
267305
----
268306

269307
.. doxygenfile:: hash.hpp
270308
:project: api
271309
:path: ../../include/chimbuko/util//hash.hpp
272310

311+
map
312+
---
313+
314+
.. doxygenfile:: map.hpp
315+
:project: api
316+
:path: ../../include/chimbuko/util//map.hpp
317+
318+
memutils
319+
--------
320+
321+
.. doxygenfile:: memutils.hpp
322+
:project: api
323+
:path: ../../include/chimbuko/util//memutils.hpp
324+
273325
mtQueue
274326
-------
275327

@@ -312,6 +364,13 @@ threadPool
312364
:project: api
313365
:path: ../../include/chimbuko/util//threadPool.hpp
314366

367+
time
368+
----
369+
370+
.. doxygenfile:: time.hpp
371+
:project: api
372+
:path: ../../include/chimbuko/util//time.hpp
373+
315374
verbose
316375
-------
317376

sphinx/source/install_usage/run_chimbuko.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ Where the variables are as follows:
8888
- **${VIZ_INSTALL_DIR}**: The directory where the visualization module is installed
8989

9090
Henceforth we assign the variable **${VIZ_ADDRESS}=${HEAD_NODE_IP}:${VIZ_PORT}**.
91+
92+
For details on the installation and usage of the visualization module, please refer to the `readme <https://github.com/CODARcode/ChimbukoVisualizationII>`_.
9193

9294
----------------------------------
9395

0 commit comments

Comments
 (0)