-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathoverride_interface_8cc-example.html
More file actions
228 lines (226 loc) · 14.4 KB
/
override_interface_8cc-example.html
File metadata and controls
228 lines (226 loc) · 14.4 KB
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Reinforcement Learning: override_interface.cc</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">Reinforcement Learning
 <span id="projectnumber">1.1</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('override_interface_8cc-example.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">override_interface.cc</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="preprocessor">#include "config_utility.h"</span></div>
<div class="line"><span class="preprocessor">#include "constants.h"</span></div>
<div class="line"><span class="preprocessor">#include "factory_resolver.h"</span></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="live__model_8h.html">live_model.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "sender.h"</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#include <fstream></span></div>
<div class="line"><span class="preprocessor">#include <iostream></span></div>
<div class="line"><span class="preprocessor">#include <mutex></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// Namespace manipulation for brevity</span></div>
<div class="line"><span class="keyword">namespace </span>r = <a class="code" href="namespacereinforcement__learning.html">reinforcement_learning</a>;</div>
<div class="line"><span class="keyword">namespace </span>u = r::utility;</div>
<div class="line"><span class="keyword">namespace </span>err = r::error_code;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Custom implementations must inherit from the respective i_* abstract class.</span></div>
<div class="line"><span class="keyword">class </span>ostream_sender : <span class="keyword">public</span> r::i_sender</div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> ostream_sender(std::ostream& stream, std::mutex& mutex) : _stream(stream), _mutex(mutex) {}</div>
<div class="line"> </div>
<div class="line"> <span class="keywordtype">int</span> init(<span class="keyword">const</span> u::configuration& config, r::api_status* status)<span class="keyword"> override </span>{ <span class="keywordflow">return</span> err::success; }</div>
<div class="line"> </div>
<div class="line"><span class="keyword">protected</span>:</div>
<div class="line"> <span class="keywordtype">int</span> v_send(<span class="keyword">const</span> buffer& data, r::api_status* status)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword"> </span>{</div>
<div class="line"> std::lock_guard<std::mutex> lock(_mutex);</div>
<div class="line"> _stream.write(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">></span>(data->body_begin()), data->body_filled_size());</div>
<div class="line"> _stream << std::endl;</div>
<div class="line"> <span class="keywordflow">return</span> err::success;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line"> std::ostream& _stream;</div>
<div class="line"> std::mutex& _mutex;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Load contents of file into a string</span></div>
<div class="line"><span class="keywordtype">int</span> load_file(<span class="keyword">const</span> std::string& file_name, std::string& config_str)</div>
<div class="line">{</div>
<div class="line"> std::ifstream fs;</div>
<div class="line"> fs.open(file_name);</div>
<div class="line"> <span class="keywordflow">if</span> (!fs.good()) { <span class="keywordflow">return</span> err::invalid_argument; }</div>
<div class="line"> std::stringstream buffer;</div>
<div class="line"> buffer << fs.rdbuf();</div>
<div class="line"> config_str = buffer.str();</div>
<div class="line"> <span class="keywordflow">return</span> err::success;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Load config from json file</span></div>
<div class="line"><span class="keywordtype">int</span> load_config_from_json(<span class="keyword">const</span> std::string& file_name, u::configuration& cfg)</div>
<div class="line">{</div>
<div class="line"> std::string config_str;</div>
<div class="line"> <a name="a0"></a><a class="code" href="api__status_8h.html#a11385635c23358843d733b2e6f3241c4">RETURN_IF_FAIL</a>(load_file(file_name, config_str));</div>
<div class="line"> <a class="code" href="api__status_8h.html#a11385635c23358843d733b2e6f3241c4">RETURN_IF_FAIL</a>(u::config::create_from_json(config_str, cfg));</div>
<div class="line"> <span class="keywordflow">return</span> err::success;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main()</div>
<div class="line">{</div>
<div class="line"> u::configuration config;</div>
<div class="line"> <span class="keywordflow">if</span> (load_config_from_json(<span class="stringliteral">"client.json"</span>, config) != err::success)</div>
<div class="line"> {</div>
<div class="line"> std::cout << <span class="stringliteral">"Unable to Load file: client.json"</span> << std::endl;</div>
<div class="line"> <span class="keywordflow">return</span> -1;</div>
<div class="line"> }</div>
<div class="line"> r::api_status status;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Used to synchronize writes to cout across multiple logger.</span></div>
<div class="line"> std::mutex cout_mutex;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Define a create function to be used in the factory.</span></div>
<div class="line"> <span class="keyword">auto</span> <span class="keyword">const</span> create_ostream_sender_fn = [&](std::unique_ptr<r::i_sender>& retval, <span class="keyword">const</span> u::configuration&,</div>
<div class="line"> r::error_callback_fn* error_callback, r::i_trace* trace, r::api_status*)</div>
<div class="line"> {</div>
<div class="line"> retval.reset(<span class="keyword">new</span> ostream_sender(std::cout, cout_mutex));</div>
<div class="line"> <span class="keywordflow">return</span> err::success;</div>
<div class="line"> };</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Create a local factory and register the create function with it using the corresponding implementation keys defined</span></div>
<div class="line"> <span class="comment">// in constants.h</span></div>
<div class="line"> r::sender_factory_t stdout_logger_factory;</div>
<div class="line"> stdout_logger_factory.register_type(r::value::OBSERVATION_EH_SENDER, create_ostream_sender_fn);</div>
<div class="line"> stdout_logger_factory.register_type(r::value::INTERACTION_EH_SENDER, create_ostream_sender_fn);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Default factories defined in factory_resolver.h are passed as well as the custom stdout logger.</span></div>
<div class="line"> r::live_model model(config, <span class="keyword">nullptr</span>, <span class="keyword">nullptr</span>, &r::trace_logger_factory, &r::data_transport_factory, &r::model_factory,</div>
<div class="line"> &stdout_logger_factory);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (model.init(&status) != err::success)</div>
<div class="line"> {</div>
<div class="line"> std::cout << status.get_error_msg() << std::endl;</div>
<div class="line"> <span class="keywordflow">return</span> -1;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> r::ranking_response response;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordtype">char</span> <span class="keyword">const</span>* <span class="keyword">const</span> event_id = <span class="stringliteral">"event_id"</span>;</div>
<div class="line"> <span class="keyword">const</span> <span class="keyword">auto</span>* <span class="keyword">const</span> context =</div>
<div class="line"> R<span class="stringliteral">"({"GUser":{"id":"a","major":"eng","hobby":"hiking"},"_multi":[ { "TAction":{"a1":"f1"} },{"TAction":{"a2":"f2"}}]})";</span></div>
<div class="line"><span class="stringliteral"> </span><span class="keywordtype">float</span> outcome = 1.0f;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (model.choose_rank(event_id, context, response, &status) != err::success)</div>
<div class="line"> {</div>
<div class="line"> std::cout << status.get_error_msg() << std::endl;</div>
<div class="line"> <span class="keywordflow">return</span> -1;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (model.report_outcome(event_id, outcome, &status) != err::success)</div>
<div class="line"> {</div>
<div class="line"> std::cout << status.get_error_msg() << std::endl;</div>
<div class="line"> <span class="keywordflow">return</span> -1;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aapi__status_8h_html_a11385635c23358843d733b2e6f3241c4"><div class="ttname"><a href="api__status_8h.html#a11385635c23358843d733b2e6f3241c4">RETURN_IF_FAIL</a></div><div class="ttdeci">#define RETURN_IF_FAIL(x)</div><div class="ttdoc">Error reporting macro to test and return on error.</div><div class="ttdef"><b>Definition:</b> api_status.h:244</div></div>
<div class="ttc" id="alive__model_8h_html"><div class="ttname"><a href="live__model_8h.html">live_model.h</a></div><div class="ttdoc">RL Inference API definition.</div></div>
<div class="ttc" id="anamespacereinforcement__learning_html"><div class="ttname"><a href="namespacereinforcement__learning.html">reinforcement_learning</a></div><div class="ttdoc">[Error Generator]</div><div class="ttdef"><b>Definition:</b> live_model.h:25</div></div>
</div><!-- fragment --> </div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>