Skip to content

Commit 8a1454a

Browse files
BaunsgaardBaunsgaard
committed
[DOCS] Update Automated Docs
1 parent 276d153 commit 8a1454a

File tree

438 files changed

+27340
-4852
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

438 files changed

+27340
-4852
lines changed

‎docs/api/java/allclasses-frame.html‎

Lines changed: 39 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/api/java/allclasses-noframe.html‎

Lines changed: 39 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/api/java/constant-values.html‎

Lines changed: 89 additions & 42 deletions
Large diffs are not rendered by default.

‎docs/api/java/index-all.html‎

Lines changed: 853 additions & 157 deletions
Large diffs are not rendered by default.

‎docs/api/java/org/apache/sysds/api/DMLOptions.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,14 @@ <h3>Field Summary</h3>
168168
</tr>
169169
<tr class="altColor">
170170
<td class="colFirst"><code>boolean</code></td>
171+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLOptions.html#fedStats">fedStats</a></span></code>&nbsp;</td>
172+
</tr>
173+
<tr class="rowColor">
174+
<td class="colFirst"><code>int</code></td>
175+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLOptions.html#fedStatsCount">fedStatsCount</a></span></code>&nbsp;</td>
176+
</tr>
177+
<tr class="altColor">
178+
<td class="colFirst"><code>boolean</code></td>
171179
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLOptions.html#fedWorker">fedWorker</a></span></code>&nbsp;</td>
172180
</tr>
173181
<tr class="rowColor">
@@ -352,6 +360,24 @@ <h4>statsCount</h4>
352360
<pre>public&nbsp;int statsCount</pre>
353361
</li>
354362
</ul>
363+
<a name="fedStats">
364+
<!-- -->
365+
</a>
366+
<ul class="blockList">
367+
<li class="blockList">
368+
<h4>fedStats</h4>
369+
<pre>public&nbsp;boolean fedStats</pre>
370+
</li>
371+
</ul>
372+
<a name="fedStatsCount">
373+
<!-- -->
374+
</a>
375+
<ul class="blockList">
376+
<li class="blockList">
377+
<h4>fedStatsCount</h4>
378+
<pre>public&nbsp;int fedStatsCount</pre>
379+
</li>
380+
</ul>
355381
<a name="memStats">
356382
<!-- -->
357383
</a>

‎docs/api/java/org/apache/sysds/api/DMLScript.html‎

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
catch(err) {
1919
}
2020
//-->
21-
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9};
21+
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9};
2222
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
2323
var altColor = "altColor";
2424
var rowColor = "rowColor";
@@ -166,6 +166,14 @@ <h3>Field Summary</h3>
166166
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#EXPLAIN">EXPLAIN</a></span></code>&nbsp;</td>
167167
</tr>
168168
<tr class="rowColor">
169+
<td class="colFirst"><code>static boolean</code></td>
170+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#FED_STATISTICS">FED_STATISTICS</a></span></code>&nbsp;</td>
171+
</tr>
172+
<tr class="altColor">
173+
<td class="colFirst"><code>static int</code></td>
174+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#FED_STATISTICS_COUNT">FED_STATISTICS_COUNT</a></span></code>&nbsp;</td>
175+
</tr>
176+
<tr class="rowColor">
169177
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
170178
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#FLOATING_POINT_PRECISION">FLOATING_POINT_PRECISION</a></span></code>&nbsp;</td>
171179
</tr>
@@ -316,27 +324,34 @@ <h3>Method Summary</h3>
316324
</td>
317325
</tr>
318326
<tr id="i8" class="altColor">
327+
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
328+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#readDMLScript-boolean-java.lang.String-">readDMLScript</a></span>(boolean&nbsp;isFile,
329+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;scriptOrFilename)</code>
330+
<div class="block">Reads the DML/PyDML script into a String</div>
331+
</td>
332+
</tr>
333+
<tr id="i9" class="rowColor">
319334
<td class="colFirst"><code>static void</code></td>
320335
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setActiveAM--">setActiveAM</a></span>()</code>&nbsp;</td>
321336
</tr>
322-
<tr id="i9" class="rowColor">
337+
<tr id="i10" class="altColor">
323338
<td class="colFirst"><code>static void</code></td>
324339
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setGlobalExecMode-org.apache.sysds.common.Types.ExecMode-">setGlobalExecMode</a></span>(<a href="../../../../org/apache/sysds/common/Types.ExecMode.html" title="enum in org.apache.sysds.common">Types.ExecMode</a>&nbsp;mode)</code>&nbsp;</td>
325340
</tr>
326-
<tr id="i10" class="altColor">
341+
<tr id="i11" class="rowColor">
327342
<td class="colFirst"><code>static void</code></td>
328343
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setGlobalFlags-org.apache.sysds.conf.DMLConfig-">setGlobalFlags</a></span>(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;dmlconf)</code>
329344
<div class="block">Sets the global flags in DMLScript based on user provided configuration</div>
330345
</td>
331346
</tr>
332-
<tr id="i11" class="rowColor">
347+
<tr id="i12" class="altColor">
333348
<td class="colFirst"><code>static void</code></td>
334349
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setUUID-java.lang.String-">setUUID</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uuid)</code>
335350
<div class="block">Used to set master UUID on all nodes (in parfor remote, where DMLScript passed)
336351
in order to simplify cleanup of scratch_space and local working dirs.</div>
337352
</td>
338353
</tr>
339-
<tr id="i12" class="altColor">
354+
<tr id="i13" class="rowColor">
340355
<td class="colFirst"><code>static boolean</code></td>
341356
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#suppressPrint2Stdout--">suppressPrint2Stdout</a></span>()</code>&nbsp;</td>
342357
</tr>
@@ -398,6 +413,24 @@ <h4>STATISTICS_MAX_WRAP_LEN</h4>
398413
<pre>public static&nbsp;int STATISTICS_MAX_WRAP_LEN</pre>
399414
</li>
400415
</ul>
416+
<a name="FED_STATISTICS">
417+
<!-- -->
418+
</a>
419+
<ul class="blockList">
420+
<li class="blockList">
421+
<h4>FED_STATISTICS</h4>
422+
<pre>public static&nbsp;boolean FED_STATISTICS</pre>
423+
</li>
424+
</ul>
425+
<a name="FED_STATISTICS_COUNT">
426+
<!-- -->
427+
</a>
428+
<ul class="blockList">
429+
<li class="blockList">
430+
<h4>FED_STATISTICS_COUNT</h4>
431+
<pre>public static&nbsp;int FED_STATISTICS_COUNT</pre>
432+
</li>
433+
</ul>
401434
<a name="EXPLAIN">
402435
<!-- -->
403436
</a>
@@ -731,6 +764,27 @@ <h4>executeScript</h4>
731764
</dl>
732765
</li>
733766
</ul>
767+
<a name="readDMLScript-boolean-java.lang.String-">
768+
<!-- -->
769+
</a>
770+
<ul class="blockList">
771+
<li class="blockList">
772+
<h4>readDMLScript</h4>
773+
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;readDMLScript(boolean&nbsp;isFile,
774+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;scriptOrFilename)
775+
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
776+
<div class="block">Reads the DML/PyDML script into a String</div>
777+
<dl>
778+
<dt><span class="paramLabel">Parameters:</span></dt>
779+
<dd><code>isFile</code> - Whether the string argument is a path to a file or the script itself</dd>
780+
<dd><code>scriptOrFilename</code> - script or filename</dd>
781+
<dt><span class="returnLabel">Returns:</span></dt>
782+
<dd>a string representation of the script</dd>
783+
<dt><span class="throwsLabel">Throws:</span></dt>
784+
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if error</dd>
785+
</dl>
786+
</li>
787+
</ul>
734788
<a name="setGlobalFlags-org.apache.sysds.conf.DMLConfig-">
735789
<!-- -->
736790
</a>

‎docs/api/java/org/apache/sysds/api/class-use/DMLException.html‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,14 @@ <h2 title="Uses of Class org.apache.sysds.api.DMLException" class="title">Uses o
9999
<td class="colLast">&nbsp;</td>
100100
</tr>
101101
<tr class="altColor">
102-
<td class="colFirst"><a href="#org.apache.sysds.runtime.io.hdf5">org.apache.sysds.runtime.io.hdf5</a></td>
102+
<td class="colFirst"><a href="#org.apache.sysds.runtime.compress">org.apache.sysds.runtime.compress</a></td>
103103
<td class="colLast">&nbsp;</td>
104104
</tr>
105105
<tr class="rowColor">
106+
<td class="colFirst"><a href="#org.apache.sysds.runtime.io.hdf5">org.apache.sysds.runtime.io.hdf5</a></td>
107+
<td class="colLast">&nbsp;</td>
108+
</tr>
109+
<tr class="altColor">
106110
<td class="colFirst"><a href="#org.apache.sysds.runtime.privacy">org.apache.sysds.runtime.privacy</a></td>
107111
<td class="colLast">&nbsp;</td>
108112
</tr>
@@ -188,15 +192,11 @@ <h3>Uses of <a href="../../../../../org/apache/sysds/api/DMLException.html" titl
188192
<tbody>
189193
<tr class="altColor">
190194
<td class="colFirst"><code>class&nbsp;</code></td>
191-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/DMLCompressionException.html" title="class in org.apache.sysds.runtime">DMLCompressionException</a></span></code>&nbsp;</td>
192-
</tr>
193-
<tr class="rowColor">
194-
<td class="colFirst"><code>class&nbsp;</code></td>
195195
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/DMLRuntimeException.html" title="class in org.apache.sysds.runtime">DMLRuntimeException</a></span></code>
196196
<div class="block">This exception should be thrown to flag runtime errors -- DML equivalent to java.lang.RuntimeException.</div>
197197
</td>
198198
</tr>
199-
<tr class="altColor">
199+
<tr class="rowColor">
200200
<td class="colFirst"><code>class&nbsp;</code></td>
201201
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/DMLScriptException.html" title="class in org.apache.sysds.runtime">DMLScriptException</a></span></code>
202202
<div class="block">This exception should be thrown to flag DML Script errors.</div>
@@ -205,6 +205,24 @@ <h3>Uses of <a href="../../../../../org/apache/sysds/api/DMLException.html" titl
205205
</tbody>
206206
</table>
207207
</li>
208+
<li class="blockList"><a name="org.apache.sysds.runtime.compress">
209+
<!-- -->
210+
</a>
211+
<h3>Uses of <a href="../../../../../org/apache/sysds/api/DMLException.html" title="class in org.apache.sysds.api">DMLException</a> in <a href="../../../../../org/apache/sysds/runtime/compress/package-summary.html">org.apache.sysds.runtime.compress</a></h3>
212+
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
213+
<caption><span>Subclasses of <a href="../../../../../org/apache/sysds/api/DMLException.html" title="class in org.apache.sysds.api">DMLException</a> in <a href="../../../../../org/apache/sysds/runtime/compress/package-summary.html">org.apache.sysds.runtime.compress</a></span><span class="tabEnd">&nbsp;</span></caption>
214+
<tr>
215+
<th class="colFirst" scope="col">Modifier and Type</th>
216+
<th class="colLast" scope="col">Class and Description</th>
217+
</tr>
218+
<tbody>
219+
<tr class="altColor">
220+
<td class="colFirst"><code>class&nbsp;</code></td>
221+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/DMLCompressionException.html" title="class in org.apache.sysds.runtime.compress">DMLCompressionException</a></span></code>&nbsp;</td>
222+
</tr>
223+
</tbody>
224+
</table>
225+
</li>
208226
<li class="blockList"><a name="org.apache.sysds.runtime.io.hdf5">
209227
<!-- -->
210228
</a>

‎docs/api/java/org/apache/sysds/api/package-use.html‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,14 @@ <h1 title="Uses of Package org.apache.sysds.api" class="title">Uses of Package<b
111111
<td class="colLast">&nbsp;</td>
112112
</tr>
113113
<tr class="rowColor">
114-
<td class="colFirst"><a href="#org.apache.sysds.runtime.io.hdf5">org.apache.sysds.runtime.io.hdf5</a></td>
114+
<td class="colFirst"><a href="#org.apache.sysds.runtime.compress">org.apache.sysds.runtime.compress</a></td>
115115
<td class="colLast">&nbsp;</td>
116116
</tr>
117117
<tr class="altColor">
118+
<td class="colFirst"><a href="#org.apache.sysds.runtime.io.hdf5">org.apache.sysds.runtime.io.hdf5</a></td>
119+
<td class="colLast">&nbsp;</td>
120+
</tr>
121+
<tr class="rowColor">
118122
<td class="colFirst"><a href="#org.apache.sysds.runtime.privacy">org.apache.sysds.runtime.privacy</a></td>
119123
<td class="colLast">&nbsp;</td>
120124
</tr>
@@ -246,6 +250,23 @@ <h1 title="Uses of Package org.apache.sysds.api" class="title">Uses of Package<b
246250
</tbody>
247251
</table>
248252
</li>
253+
<li class="blockList"><a name="org.apache.sysds.runtime.compress">
254+
<!-- -->
255+
</a>
256+
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
257+
<caption><span>Classes in <a href="../../../../org/apache/sysds/api/package-summary.html">org.apache.sysds.api</a> used by <a href="../../../../org/apache/sysds/runtime/compress/package-summary.html">org.apache.sysds.runtime.compress</a></span><span class="tabEnd">&nbsp;</span></caption>
258+
<tr>
259+
<th class="colOne" scope="col">Class and Description</th>
260+
</tr>
261+
<tbody>
262+
<tr class="altColor">
263+
<td class="colOne"><a href="../../../../org/apache/sysds/api/class-use/DMLException.html#org.apache.sysds.runtime.compress">DMLException</a>
264+
<div class="block">Exception occurring in the DML framework.</div>
265+
</td>
266+
</tr>
267+
</tbody>
268+
</table>
269+
</li>
249270
<li class="blockList"><a name="org.apache.sysds.runtime.io.hdf5">
250271
<!-- -->
251272
</a>

0 commit comments

Comments
 (0)