blob: 29a22a000088c0cc707d68c8aadec0412a18f227 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.apache.sysds.api.mlcontext.FrameMetadata (SystemDS 2.1.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class org.apache.sysds.api.mlcontext.FrameMetadata (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/api/mlcontext/class-use/FrameMetadata.html" target="_top">Frames</a></li>
<li><a href="FrameMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.sysds.api.mlcontext.FrameMetadata" class="title">Uses of Class<br>org.apache.sysds.api.mlcontext.FrameMetadata</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.sysds.api.mlcontext">org.apache.sysds.api.mlcontext</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.sysds.api.mlcontext">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a> in <a href="../../../../../../org/apache/sysds/api/mlcontext/package-summary.html">org.apache.sysds.api.mlcontext</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/apache/sysds/api/mlcontext/package-summary.html">org.apache.sysds.api.mlcontext</a> that return <a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></code></td>
<td class="colLast"><span class="typeNameLabel">Frame.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/Frame.html#getFrameMetadata--">getFrameMetadata</a></span>()</code>
<div class="block">Obtain the frame metadata</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/apache/sysds/api/mlcontext/package-summary.html">org.apache.sysds.api.mlcontext</a> with parameters of type <a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#binaryBlocksToFrameObject-org.apache.spark.api.java.JavaPairRDD-org.apache.sysds.api.mlcontext.FrameMetadata-">binaryBlocksToFrameObject</a></span>(org.apache.spark.api.java.JavaPairRDD&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="../../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&gt;&nbsp;binaryBlocks,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>JavaPairRDD&lt;Long, FrameBlock&gt;</code> to a <code>FrameObject</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.apache.spark.api.java.JavaPairRDD&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="../../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#dataFrameToFrameBinaryBlocks-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.FrameMetadata-">dataFrameToFrameBinaryBlocks</a></span>(org.apache.spark.sql.Dataset&lt;org.apache.spark.sql.Row&gt;&nbsp;dataFrame,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>DataFrame</code> to a <code>JavaPairRDD&lt;Long, FrameBlock&gt;</code>
binary-block frame.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#dataFrameToFrameObject-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.FrameMetadata-">dataFrameToFrameObject</a></span>(org.apache.spark.sql.Dataset&lt;org.apache.spark.sql.Row&gt;&nbsp;dataFrame,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>DataFrame</code> to a <code>FrameObject</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#determineFrameFormatIfNeeded-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.FrameMetadata-">determineFrameFormatIfNeeded</a></span>(org.apache.spark.sql.Dataset&lt;org.apache.spark.sql.Row&gt;&nbsp;dataFrame,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">If the FrameFormat of the DataFrame has not been explicitly specified,
attempt to determine the proper FrameFormat.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#frameBlockToFrameObject-java.lang.String-org.apache.sysds.runtime.matrix.data.FrameBlock-org.apache.sysds.api.mlcontext.FrameMetadata-">frameBlockToFrameObject</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;variableName,
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&nbsp;frameBlock,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>FrameBlock</code> to a <code>FrameObject</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#isDataFrameWithIDColumn-org.apache.sysds.api.mlcontext.FrameMetadata-">isDataFrameWithIDColumn</a></span>(<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Return whether or not the DataFrame has an ID column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#javaRDDStringCSVToFrameObject-org.apache.spark.api.java.JavaRDD-org.apache.sysds.api.mlcontext.FrameMetadata-">javaRDDStringCSVToFrameObject</a></span>(org.apache.spark.api.java.JavaRDD&lt;<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>&gt;&nbsp;javaRDD,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>JavaRDD&lt;String&gt;</code> in CSV format to a <code>FrameObject</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#javaRDDStringIJVToFrameObject-org.apache.spark.api.java.JavaRDD-org.apache.sysds.api.mlcontext.FrameMetadata-">javaRDDStringIJVToFrameObject</a></span>(org.apache.spark.api.java.JavaRDD&lt;<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>&gt;&nbsp;javaRDD,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>JavaRDD&lt;String&gt;</code> in IJV format to a <code>FrameObject</code>
.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#rddStringCSVToFrameObject-org.apache.spark.rdd.RDD-org.apache.sysds.api.mlcontext.FrameMetadata-">rddStringCSVToFrameObject</a></span>(org.apache.spark.rdd.RDD&lt;<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>&gt;&nbsp;rdd,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>RDD&lt;String&gt;</code> in CSV format to a <code>FrameObject</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a></code></td>
<td class="colLast"><span class="typeNameLabel">MLContextConversionUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html#rddStringIJVToFrameObject-org.apache.spark.rdd.RDD-org.apache.sysds.api.mlcontext.FrameMetadata-">rddStringIJVToFrameObject</a></span>(org.apache.spark.rdd.RDD&lt;<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>&gt;&nbsp;rdd,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a <code>RDD&lt;String&gt;</code> in IJV format to a <code>FrameObject</code>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructors in <a href="../../../../../../org/apache/sysds/api/mlcontext/package-summary.html">org.apache.sysds.api.mlcontext</a> with parameters of type <a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/Frame.html#Frame-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.FrameMetadata-">Frame</a></span>(org.apache.spark.sql.Dataset&lt;org.apache.spark.sql.Row&gt;&nbsp;dataFrame,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/api/mlcontext/Frame.html#Frame-org.apache.spark.api.java.JavaPairRDD-org.apache.sysds.api.mlcontext.FrameMetadata-">Frame</a></span>(org.apache.spark.api.java.JavaPairRDD&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="../../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&gt;&nbsp;binaryBlocks,
<a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a>&nbsp;frameMetadata)</code>
<div class="block">Create a Frame, specifying the SystemDS binary-block frame and its
metadata.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/api/mlcontext/class-use/FrameMetadata.html" target="_top">Frames</a></li>
<li><a href="FrameMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>