-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathactive_8h.html
143 lines (137 loc) · 18.5 KB
/
active_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vowpal Wabbit: /mnt/c/w/linux/vowpal_wabbit/vowpalwabbit/active.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Vowpal Wabbit
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_23e69c20c74a4591a9cfc65aaff8f3d1.html">vowpalwabbit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">active.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <memory></code><br />
</div>
<p><a href="active_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structactive.html">active</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae45dc77e379230dd62970bf5cfa18c3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceLEARNER.html#a807843d5185e0c5005a54bf28c111c79">LEARNER::base_learner</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="active_8h.html#ae45dc77e379230dd62970bf5cfa18c3e">active_setup</a> (<a class="el" href="structVW_1_1config_1_1options__i.html">VW::config::options_i</a> &options, <a class="el" href="structvw.html">vw</a> &all)</td></tr>
<tr class="separator:ae45dc77e379230dd62970bf5cfa18c3e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae45dc77e379230dd62970bf5cfa18c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae45dc77e379230dd62970bf5cfa18c3e">◆ </a></span>active_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceLEARNER.html#a807843d5185e0c5005a54bf28c111c79">LEARNER::base_learner</a>* active_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structVW_1_1config_1_1options__i.html">VW::config::options_i</a> & </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structvw.html">vw</a> & </td>
<td class="paramname"><em>all</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="active_8cc_source.html#l00133">133</a> of file <a class="el" href="active_8cc_source.html">active.cc</a>.</p>
<p class="reference">References <a class="el" href="global__data_8h_source.html#l00489">vw::active</a>, <a class="el" href="options_8h_source.html#l00090">VW::config::option_group_definition::add()</a>, <a class="el" href="structVW_1_1config_1_1options__i.html#a93c0de6c3ad57f6fb57441af2c908ba5">VW::config::options_i::add_and_parse()</a>, <a class="el" href="learner_8h_source.html#l00476">LEARNER::as_singleline()</a>, <a class="el" href="global__data_8h_source.html#l00553">vw::get_random_state()</a>, <a class="el" href="learner_8h_source.html#l00369">LEARNER::init_learner()</a>, <a class="el" href="learner_8h_source.html#l00462">LEARNER::make_base()</a>, <a class="el" href="options_8h_source.html#l00080">VW::config::make_option()</a>, <a class="el" href="active_8cc_source.html#l00127">return_active_example()</a>, <a class="el" href="learner_8h_source.html#l00307">LEARNER::learner< T, E >::set_finish_example()</a>, <a class="el" href="parse__args_8cc_source.html#l01222">setup_base()</a>, <a class="el" href="vw__exception_8h_source.html#l00181">THROW</a>, and <a class="el" href="structVW_1_1config_1_1options__i.html#ab5171ac33158fca4580d3f0658c4929e">VW::config::options_i::was_supplied()</a>.</p>
<p class="reference">Referenced by <a class="el" href="parse__args_8cc_source.html#l01234">parse_reductions()</a>.</p>
<div class="fragment"><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">auto</span> data = scoped_calloc_or_throw<active>();</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">bool</span> active_option = <span class="keyword">false</span>;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">bool</span> simulation = <span class="keyword">false</span>;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="structVW_1_1config_1_1option__group__definition.html">option_group_definition</a> new_options(<span class="stringliteral">"Active Learning"</span>);</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  new_options.add(<a class="code" href="namespaceVW_1_1config.html#ae768389a49d24d07215612b2f824d520">make_option</a>(<span class="stringliteral">"active"</span>, active_option).keep().help(<span class="stringliteral">"enable active learning"</span>))</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  .add(<a class="code" href="namespaceVW_1_1config.html#ae768389a49d24d07215612b2f824d520">make_option</a>(<span class="stringliteral">"simulation"</span>, simulation).help(<span class="stringliteral">"active learning simulation mode"</span>))</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  .add(<a class="code" href="namespaceVW_1_1config.html#ae768389a49d24d07215612b2f824d520">make_option</a>(<span class="stringliteral">"mellowness"</span>, data->active_c0)</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  .default_value(8.f)</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  .help(<span class="stringliteral">"active learning mellowness parameter c_0. Default 8"</span>));</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  options.<a class="code" href="structVW_1_1config_1_1options__i.html#a93c0de6c3ad57f6fb57441af2c908ba5">add_and_parse</a>(new_options);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordflow">if</span> (!active_option)</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  data->all = &all;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  data->_random_state = all.<a class="code" href="structvw.html#a30bca3f2116b0b7db82d60c76467f6c4">get_random_state</a>();</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">if</span> (options.<a class="code" href="structVW_1_1config_1_1options__i.html#ab5171ac33158fca4580d3f0658c4929e">was_supplied</a>(<span class="stringliteral">"lda"</span>))</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="vw__exception_8h.html#a6418ba1768107875abafe9a0b6b8b2ad">THROW</a>(<span class="stringliteral">"error: you can't combine lda and active learning"</span>);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">auto</span> base = <a class="code" href="namespaceLEARNER.html#abd71c87941b752738319b3d1ed64fe47">as_singleline</a>(<a class="code" href="parse__args_8cc.html#a34c806099b7857a0ffc630bc8142beba">setup_base</a>(options, all));</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// Create new learner</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="structLEARNER_1_1learner.html">learner<active, example></a>* l;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordflow">if</span> (options.<a class="code" href="structVW_1_1config_1_1options__i.html#ab5171ac33158fca4580d3f0658c4929e">was_supplied</a>(<span class="stringliteral">"simulation"</span>))</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  l = &<a class="code" href="namespaceLEARNER.html#a46de7ca84ed37d7b45dc7db64420b978">init_learner</a>(data, base, predict_or_learn_simulation<true>, predict_or_learn_simulation<false>);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  {</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  all.<a class="code" href="structvw.html#a150b8efa21ed8f6425698892a17537a8">active</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  l = &<a class="code" href="namespaceLEARNER.html#a46de7ca84ed37d7b45dc7db64420b978">init_learner</a>(data, base, predict_or_learn_active<true>, predict_or_learn_active<false>);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  l-><a class="code" href="structLEARNER_1_1learner.html#a459cdbfe2232f11e6c73933961af97e1">set_finish_example</a>(<a class="code" href="active_8cc.html#a97ff1bf040bedd7546bacfa3afd82f37">return_active_example</a>);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  }</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceLEARNER.html#abcf6bdc2fa5e38928c33212e20dbbd74">make_base</a>(*l);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> }</div><div class="ttc" id="active_8cc_html_a97ff1bf040bedd7546bacfa3afd82f37"><div class="ttname"><a href="active_8cc.html#a97ff1bf040bedd7546bacfa3afd82f37">return_active_example</a></div><div class="ttdeci">void return_active_example(vw &all, active &a, example &ec)</div><div class="ttdef"><b>Definition:</b> <a href="active_8cc_source.html#l00127">active.cc:127</a></div></div>
<div class="ttc" id="namespaceLEARNER_html_abcf6bdc2fa5e38928c33212e20dbbd74"><div class="ttname"><a href="namespaceLEARNER.html#abcf6bdc2fa5e38928c33212e20dbbd74">LEARNER::make_base</a></div><div class="ttdeci">base_learner * make_base(learner< T, E > &base)</div><div class="ttdef"><b>Definition:</b> <a href="learner_8h_source.html#l00462">learner.h:462</a></div></div>
<div class="ttc" id="structVW_1_1config_1_1option__group__definition_html"><div class="ttname"><a href="structVW_1_1config_1_1option__group__definition.html">VW::config::option_group_definition</a></div><div class="ttdef"><b>Definition:</b> <a href="options_8h_source.html#l00085">options.h:85</a></div></div>
<div class="ttc" id="structVW_1_1config_1_1options__i_html_a93c0de6c3ad57f6fb57441af2c908ba5"><div class="ttname"><a href="structVW_1_1config_1_1options__i.html#a93c0de6c3ad57f6fb57441af2c908ba5">VW::config::options_i::add_and_parse</a></div><div class="ttdeci">virtual void add_and_parse(const option_group_definition &group)=0</div></div>
<div class="ttc" id="structLEARNER_1_1learner_html"><div class="ttname"><a href="structLEARNER_1_1learner.html">LEARNER::learner</a></div><div class="ttdef"><b>Definition:</b> <a href="cb__explore_8h_source.html#l00011">cb_explore.h:11</a></div></div>
<div class="ttc" id="structvw_html_a30bca3f2116b0b7db82d60c76467f6c4"><div class="ttname"><a href="structvw.html#a30bca3f2116b0b7db82d60c76467f6c4">vw::get_random_state</a></div><div class="ttdeci">std::shared_ptr< rand_state > get_random_state()</div><div class="ttdef"><b>Definition:</b> <a href="global__data_8h_source.html#l00553">global_data.h:553</a></div></div>
<div class="ttc" id="namespaceLEARNER_html_abd71c87941b752738319b3d1ed64fe47"><div class="ttname"><a href="namespaceLEARNER.html#abd71c87941b752738319b3d1ed64fe47">LEARNER::as_singleline</a></div><div class="ttdeci">single_learner * as_singleline(learner< T, E > *l)</div><div class="ttdef"><b>Definition:</b> <a href="learner_8h_source.html#l00476">learner.h:476</a></div></div>
<div class="ttc" id="structLEARNER_1_1learner_html_a459cdbfe2232f11e6c73933961af97e1"><div class="ttname"><a href="structLEARNER_1_1learner.html#a459cdbfe2232f11e6c73933961af97e1">LEARNER::learner::set_finish_example</a></div><div class="ttdeci">void set_finish_example(void(*f)(vw &all, T &, E &))</div><div class="ttdef"><b>Definition:</b> <a href="learner_8h_source.html#l00307">learner.h:307</a></div></div>
<div class="ttc" id="namespaceLEARNER_html_a46de7ca84ed37d7b45dc7db64420b978"><div class="ttname"><a href="namespaceLEARNER.html#a46de7ca84ed37d7b45dc7db64420b978">LEARNER::init_learner</a></div><div class="ttdeci">learner< T, E > & init_learner(free_ptr< T > &dat, L *base, void(*learn)(T &, L &, E &), void(*predict)(T &, L &, E &), size_t ws, prediction_type::prediction_type_t pred_type)</div><div class="ttdef"><b>Definition:</b> <a href="learner_8h_source.html#l00369">learner.h:369</a></div></div>
<div class="ttc" id="structvw_html_a150b8efa21ed8f6425698892a17537a8"><div class="ttname"><a href="structvw.html#a150b8efa21ed8f6425698892a17537a8">vw::active</a></div><div class="ttdeci">bool active</div><div class="ttdef"><b>Definition:</b> <a href="global__data_8h_source.html#l00489">global_data.h:489</a></div></div>
<div class="ttc" id="structVW_1_1config_1_1options__i_html_ab5171ac33158fca4580d3f0658c4929e"><div class="ttname"><a href="structVW_1_1config_1_1options__i.html#ab5171ac33158fca4580d3f0658c4929e">VW::config::options_i::was_supplied</a></div><div class="ttdeci">virtual bool was_supplied(const std::string &key)=0</div></div>
<div class="ttc" id="namespaceVW_1_1config_html_ae768389a49d24d07215612b2f824d520"><div class="ttname"><a href="namespaceVW_1_1config.html#ae768389a49d24d07215612b2f824d520">VW::config::make_option</a></div><div class="ttdeci">typed_option< T > make_option(std::string name, T &location)</div><div class="ttdef"><b>Definition:</b> <a href="options_8h_source.html#l00080">options.h:80</a></div></div>
<div class="ttc" id="parse__args_8cc_html_a34c806099b7857a0ffc630bc8142beba"><div class="ttname"><a href="parse__args_8cc.html#a34c806099b7857a0ffc630bc8142beba">setup_base</a></div><div class="ttdeci">LEARNER::base_learner * setup_base(options_i &options, vw &all)</div><div class="ttdef"><b>Definition:</b> <a href="parse__args_8cc_source.html#l01222">parse_args.cc:1222</a></div></div>
<div class="ttc" id="vw__exception_8h_html_a6418ba1768107875abafe9a0b6b8b2ad"><div class="ttname"><a href="vw__exception_8h.html#a6418ba1768107875abafe9a0b6b8b2ad">THROW</a></div><div class="ttdeci">#define THROW(args)</div><div class="ttdef"><b>Definition:</b> <a href="vw__exception_8h_source.html#l00181">vw_exception.h:181</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 9 2020 14:45:25 for Vowpal Wabbit by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>