blob: eb1c74edb6cf5f61bf7ac027242ad3a3b15d5026 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MADlib: lmf.sql_in File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script src="../mathjax/MathJax.js">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">MADlib
&#160;<span id="projectnumber">0.6</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./lmf_8sql__in.html"> A newer version is available</a></span>
</div>
<div id="projectbrief">User Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('lmf_8sql__in.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">lmf.sql_in File Reference</div> </div>
</div>
<div class="contents">
<p>SQL functions for low-rank matrix factorization.
<a href="#details">More...</a></p>
<p><a href="lmf_8sql__in_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#ac1acb1f0e1f7008118f21c83546a4602">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim=&quot;SELECT max(col_row) FROM rel_source&quot;, integer column_dim=&quot;SELECT max(col_col) FROM rel_source&quot;, integer max_rank=20, float8 stepsize=0.01, float8 scale_factor=0.1, integer num_iterations=10, float8 tolerance=0.0001)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Low-rank matrix factorization of a incomplete matrix into two factors. <a href="#ac1acb1f0e1f7008118f21c83546a4602"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><dl class="date"><dt><b>Date:</b></dt><dd>June 2012</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>For a brief introduction to Low-rank Matrix Factorization, see the module description <a class="el" href="group__grp__lmf.html">Low-rank Matrix Factorization</a>. </dd></dl>
<p>Definition in file <a class="el" href="lmf_8sql__in_source.html">lmf.sql_in</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ac1acb1f0e1f7008118f21c83546a4602"></a><!-- doxytag: member="lmf.sql_in::lmf_igd_run" ref="ac1acb1f0e1f7008118f21c83546a4602" args="(varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim=&quot;SELECT max(col_row) FROM rel_source&quot;, integer column_dim=&quot;SELECT max(col_col) FROM rel_source&quot;, integer max_rank=20, float8 stepsize=0.01, float8 scale_factor=0.1, integer num_iterations=10, float8 tolerance=0.0001)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em> = <code>&quot;SELECT&#160;max(col_row)&#160;FROM&#160;rel_source&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em> = <code>&quot;SELECT&#160;max(col_col)&#160;FROM&#160;rel_source&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em> = <code>20</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em> = <code>0.01</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>scale_factor</em> = <code>0.1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_iterations</em> = <code>10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>tolerance</em> = <code>0.0001</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function takes as input the table representation of a incomplete matrix in the sparse (i, j, value) format and decomposes it into the specified set of most significant features of matrices of U and V matrix. The input matrix is expected to have dimension [1:row_dim][1:column_dim], but in sparse format.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rel_output</td><td>Name of the table that the factors will be appended to </td></tr>
<tr><td class="paramname">rel_source</td><td>Name of the table/view with the source data </td></tr>
<tr><td class="paramname">col_row</td><td>Name of the column containing cell row number </td></tr>
<tr><td class="paramname">col_column</td><td>Name of the column containing cell column number </td></tr>
<tr><td class="paramname">col_value</td><td>Name of the column containing cell value </td></tr>
<tr><td class="paramname">row_dim</td><td>Maximum number of rows of input </td></tr>
<tr><td class="paramname">column_dim</td><td>Maximum number of columns of input </td></tr>
<tr><td class="paramname">max_rank</td><td>Rank of desired approximation </td></tr>
<tr><td class="paramname">stepsize</td><td>Hyper-parameter that decides how aggressive that the gradient steps are </td></tr>
<tr><td class="paramname">scale_factor</td><td>Hyper-parameter that decides scale of initial factors </td></tr>
<tr><td class="paramname">num_iterations</td><td>Maximum number if iterations to perform regardless of convergence </td></tr>
<tr><td class="paramname">tolerance</td><td>Acceptable level of error in convergence. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="lmf_8sql__in_source.html#l00278">278</a> of file <a class="el" href="lmf_8sql__in_source.html">lmf.sql_in</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="lmf_8sql__in.html">lmf.sql_in</a> </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<li class="footer">Generated on Tue Apr 2 2013 14:57:03 for MADlib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
</ul>
</div>
</body>
</html>