blob: 4ca11134ce4d6a8dd44736ae447889ae6ab5ee5c [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: cross_validation.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.7</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./cross__validation_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('cross__validation_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">cross_validation.sql_in File Reference</div> </div>
</div>
<div class="contents">
<p>SQL functions for cross validation.
<a href="#details">More...</a></p>
<p><a href="cross__validation_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">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#aa151eb3fa9acc7f4cc33236e22ad4362">cv_linregr_train</a> (varchar tbl_source, varchar col_ind_var, varchar col_dep_var, varchar tbl_result)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple interface of cross-validation, which has no limitation on lock number. <a href="#aa151eb3fa9acc7f4cc33236e22ad4362"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa572f1f57c0dd106b30948928161d8cc"></a><!-- doxytag: member="cross_validation.sql_in::cv_linregr_predict" ref="aa572f1f57c0dd106b30948928161d8cc" args="(varchar tbl_model, varchar tbl_newdata, varchar col_ind_var, varchar col_id, varchar tbl_predict)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#aa572f1f57c0dd106b30948928161d8cc">cv_linregr_predict</a> (varchar tbl_model, varchar tbl_newdata, varchar col_ind_var, varchar col_id, varchar tbl_predict)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper for linear regression prediction. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#a66b3cb92a758ed6ea3b8da7c6dfa516c">logregr_predict</a> (float8[] coef, float8[] col_ind)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A prediction function for logistic regression. <a href="#a66b3cb92a758ed6ea3b8da7c6dfa516c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#ac7dbc115f0c4624ccbf62b2d5494388d">cv_logregr_predict</a> (varchar tbl_model, varchar tbl_newdata, varchar col_ind_var, varchar col_id, varchar tbl_predict)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A prediction function for logistic regression The result is stored in the table of tbl_predict. <a href="#ac7dbc115f0c4624ccbf62b2d5494388d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#a2d1571ffa794176a5dfed9d35e70fed7">logregr_accuracy</a> (float8[] coef, float8[] col_ind, boolean col_dep)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Metric function for logistic regression. <a href="#a2d1571ffa794176a5dfed9d35e70fed7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cross__validation_8sql__in.html#ac1b5c57473ff672af45191c8d53f46ed">cv_logregr_accuracy</a> (varchar tbl_predict, varchar tbl_source, varchar col_id, varchar col_dep_var, varchar tbl_accuracy)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Metric function for logistic regression. <a href="#ac1b5c57473ff672af45191c8d53f46ed"></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>January 2011</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>For a brief introduction to the usage of cross validation, see the module description <a class="el" href="group__grp__validation.html">Cross Validation</a>. </dd></dl>
<p>Definition in file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="aa151eb3fa9acc7f4cc33236e22ad4362"></a><!-- doxytag: member="cross_validation.sql_in::cv_linregr_train" ref="aa151eb3fa9acc7f4cc33236e22ad4362" args="(varchar tbl_source, varchar col_ind_var, varchar col_dep_var, varchar tbl_result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cv_linregr_train </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_ind_var</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_dep_var</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module_name</td><td>Module to be cross validated </td></tr>
<tr><td class="paramname">func_args</td><td>Arguments of modelling function of the module, including the table name of data </td></tr>
<tr><td class="paramname">param_to_try</td><td>The name of the paramter that CV runs through </td></tr>
<tr><td class="paramname">param_values</td><td>The values of the parameter that CV will try </td></tr>
<tr><td class="paramname">data_id</td><td>Name of the unique ID associated with each row. Provide <em>NULL</em> if there is no such column in the data table </td></tr>
<tr><td class="paramname">id_is_random</td><td>Whether the provided ID is randomly assigned to each row </td></tr>
<tr><td class="paramname">validation_result</td><td>Table name to store the output of CV function, see the Output for format. It will be automatically created by CV function </td></tr>
<tr><td class="paramname">fold_num</td><td>How many fold cross-validation Print the help message for a given module's cross-validation. Print the supported module names for cross_validation A wrapper for linear regression </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cross__validation_8sql__in_source.html#l00366">366</a> of file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div>
</div>
<a class="anchor" id="ac1b5c57473ff672af45191c8d53f46ed"></a><!-- doxytag: member="cross_validation.sql_in::cv_logregr_accuracy" ref="ac1b5c57473ff672af45191c8d53f46ed" args="(varchar tbl_predict, varchar tbl_source, varchar col_id, varchar col_dep_var, varchar tbl_accuracy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cv_logregr_accuracy </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_predict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_dep_var</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_accuracy</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>It computes the percentage of correct predictions. The result is stored in the table of tbl_accuracy </p>
<p>Definition at line <a class="el" href="cross__validation_8sql__in_source.html#l00481">481</a> of file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div>
</div>
<a class="anchor" id="ac7dbc115f0c4624ccbf62b2d5494388d"></a><!-- doxytag: member="cross_validation.sql_in::cv_logregr_predict" ref="ac7dbc115f0c4624ccbf62b2d5494388d" args="(varchar tbl_model, varchar tbl_newdata, varchar col_ind_var, varchar col_id, varchar tbl_predict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cv_logregr_predict </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_newdata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_ind_var</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>tbl_predict</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function can be used together with cross-validation </p>
<p>Definition at line <a class="el" href="cross__validation_8sql__in_source.html#l00447">447</a> of file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div>
</div>
<a class="anchor" id="a2d1571ffa794176a5dfed9d35e70fed7"></a><!-- doxytag: member="cross_validation.sql_in::logregr_accuracy" ref="a2d1571ffa794176a5dfed9d35e70fed7" args="(float8[] coef, float8[] col_ind, boolean col_dep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer logregr_accuracy </td>
<td>(</td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>coef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>col_ind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean&#160;</td>
<td class="paramname"><em>col_dep</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">coef</td><td>Logistic fitting coefficients. Note: MADlib logregr_train function does not produce a seperate intercept term as elastic_net_train function. </td></tr>
<tr><td class="paramname">col_ind</td><td>Independent variable, an array </td></tr>
<tr><td class="paramname">col_dep</td><td>Dependent variable</td></tr>
</table>
</dd>
</dl>
<p>returns 1 if the prediction is the same as col_dep, otherwise 0 </p>
<p>Definition at line <a class="el" href="cross__validation_8sql__in_source.html#l00467">467</a> of file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div>
</div>
<a class="anchor" id="a66b3cb92a758ed6ea3b8da7c6dfa516c"></a><!-- doxytag: member="cross_validation.sql_in::logregr_predict" ref="a66b3cb92a758ed6ea3b8da7c6dfa516c" args="(float8[] coef, float8[] col_ind)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean logregr_predict </td>
<td>(</td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>coef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>col_ind</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">coef</td><td>Coefficients. Note: MADlib logregr_train function does not produce a seperate intercept term as elastic_net_train function. </td></tr>
<tr><td class="paramname">col_ind</td><td>Independent variable, which must be an array </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cross__validation_8sql__in_source.html#l00434">434</a> of file <a class="el" href="cross__validation_8sql__in_source.html">cross_validation.sql_in</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="cross__validation_8sql__in.html">cross_validation.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 Fri May 10 2013 01:37:13 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>