-
Notifications
You must be signed in to change notification settings - Fork 3
/
api_context_format.html
228 lines (226 loc) · 15.4 KB
/
api_context_format.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
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: API Context Format</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('api_context_format.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">API Context Format </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The choose_rank() call returns the chosen action among all actions defined in the context.</p>
<p>Here, the context denotes the const char* argument passed to the choose_rank() call.</p>
<p>The format of this context is a JSON string, with a specific structure. This JSON context contains two parts:</p><ul>
<li>The description of the shared features, i.e. the features shared by all actions.</li>
<li>The description of the action features, i.e. a JSON array that describes the set of features for each action.</li>
</ul>
<p>Typically, the shared features describe a user, while the action features describe all the possible actions that can be taken for this user.</p>
<p>In the following, we discuss the expected format for shared features and action features separately, and then at the end we provide an example of the expected context.</p>
<h2><a class="anchor" id="autotoc_md6"></a>
Example of shared features:</h2>
<div class="fragment"><div class="line">{</div>
<div class="line"> <span class="stringliteral">"User"</span>: {</div>
<div class="line"> <span class="stringliteral">"age"</span>: 30.6,</div>
<div class="line"> <span class="stringliteral">"gender"</span>: 1</div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"Geo"</span>: {</div>
<div class="line"> <span class="stringliteral">"country"</span>: <span class="stringliteral">"United States"</span>,</div>
<div class="line"> <span class="stringliteral">"state"</span>: <span class="stringliteral">"New York"</span>,</div>
<div class="line"> <span class="stringliteral">"city"</span>: <span class="stringliteral">"Brooklyn"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"Refer"</span>: {</div>
<div class="line"> <span class="stringliteral">"referer"</span>: <span class="stringliteral">"https://www.microsoft.com/"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"OUserAgent"</span>: {</div>
<div class="line"> <span class="stringliteral">"ua"</span>: <span class="stringliteral">"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.1.2 Safari/605.1.15"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceBrand"</span>: <span class="stringliteral">""</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceFamily"</span>: <span class="stringliteral">"Other"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceIsSpider"</span>: <span class="keyword">false</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceModel"</span>: <span class="stringliteral">""</span>,</div>
<div class="line"> <span class="stringliteral">"OSFamily"</span>: <span class="stringliteral">"Mac OS X"</span>,</div>
<div class="line"> <span class="stringliteral">"OSMajor"</span>: <span class="stringliteral">"10"</span>,</div>
<div class="line"> <span class="stringliteral">"OSPatch"</span>: <span class="stringliteral">"6"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceType"</span>: <span class="stringliteral">"Desktop"</span></div>
<div class="line"> },</div>
<div class="line"> ...</div>
<div class="line">}</div>
</div><!-- fragment --><p>Any field can take either a numeric value (like "age": 30.6 or "gender": 1), or a string value (like "country": "United States").</p>
<p>In this example we used namespaces (i.e. "User", "Geo", "Refer" and "OUserAgent"). It is always a good practice to use namespaces, even if the namespace contains only 1 single feature, because namespaces enable convenient featurization options like filtering or crossing namespaces (see Vowpal Wabbit options <a href="https://github.com/VowpalWabbit/vowpal_wabbit/wiki">https://github.com/VowpalWabbit/vowpal_wabbit/wiki</a>).</p>
<h2><a class="anchor" id="autotoc_md7"></a>
Example of actions features (3 actions):</h2>
<div class="fragment"><div class="line">{</div>
<div class="line"> ...</div>
<div class="line"> <span class="stringliteral">"_multi"</span>: [{</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 1,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"123"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"MoreInfo"</span>: {</div>
<div class="line"> <span class="stringliteral">"video"</span>: <span class="keyword">true</span>,</div>
<div class="line"> <span class="stringliteral">"blogId"</span>: <span class="stringliteral">"123456"</span></div>
<div class="line"> }</div>
<div class="line"> }, {</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 1,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"70"</span></div>
<div class="line"> }</div>
<div class="line"> }, {</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 2,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"73"</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> ]</div>
<div class="line">}</div>
</div><!-- fragment --><p>The action features follow the same rules as shared features. Note that each action can have a different set of features.</p>
<h2><a class="anchor" id="autotoc_md8"></a>
Reserved field names:</h2>
<p>The field name "_multi" is reserved for action features. Its value is a JSON array, where each JSON object in the array defines one specific action.</p>
<p>Another field name, "_text", splits the containing string into features. For example: </p><div class="fragment"><div class="line"><span class="stringliteral">"_text"</span>: <span class="stringliteral">"London UK"</span></div>
</div><!-- fragment --><p> becomes </p><div class="fragment"><div class="line"><span class="stringliteral">"London"</span>: 1,</div>
<div class="line"><span class="stringliteral">"UK"</span>: 1</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md9"></a>
A full example of the expected context (note that newlines shouldn't be included):</h2>
<div class="fragment"><div class="line">{</div>
<div class="line"> <span class="stringliteral">"User"</span>: {</div>
<div class="line"> <span class="stringliteral">"age"</span>: 30.6,</div>
<div class="line"> <span class="stringliteral">"gender"</span>: 1</div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"Geo"</span>: {</div>
<div class="line"> <span class="stringliteral">"country"</span>: <span class="stringliteral">"United States"</span>,</div>
<div class="line"> <span class="stringliteral">"state"</span>: <span class="stringliteral">"New York"</span>,</div>
<div class="line"> <span class="stringliteral">"city"</span>: <span class="stringliteral">"Brooklyn"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"Refer"</span>: {</div>
<div class="line"> <span class="stringliteral">"referer"</span>: <span class="stringliteral">"https://www.microsoft.com/"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"OUserAgent"</span>: {</div>
<div class="line"> <span class="stringliteral">"ua"</span>: <span class="stringliteral">"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.1.2 Safari/605.1.15"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceBrand"</span>: <span class="stringliteral">""</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceFamily"</span>: <span class="stringliteral">"Other"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceIsSpider"</span>: <span class="keyword">false</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceModel"</span>: <span class="stringliteral">""</span>,</div>
<div class="line"> <span class="stringliteral">"OSFamily"</span>: <span class="stringliteral">"Mac OS X"</span>,</div>
<div class="line"> <span class="stringliteral">"OSMajor"</span>: <span class="stringliteral">"10"</span>,</div>
<div class="line"> <span class="stringliteral">"OSPatch"</span>: <span class="stringliteral">"6"</span>,</div>
<div class="line"> <span class="stringliteral">"DeviceType"</span>: <span class="stringliteral">"Desktop"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"_multi"</span>: [{</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 1,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"123"</span></div>
<div class="line"> },</div>
<div class="line"> <span class="stringliteral">"MoreInfo"</span>: {</div>
<div class="line"> <span class="stringliteral">"video"</span>: <span class="keyword">true</span>,</div>
<div class="line"> <span class="stringliteral">"blogId"</span>: <span class="stringliteral">"123456"</span></div>
<div class="line"> }</div>
<div class="line"> }, {</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 1,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"70"</span></div>
<div class="line"> }</div>
<div class="line"> }, {</div>
<div class="line"> <span class="stringliteral">"Action"</span>: {</div>
<div class="line"> <span class="stringliteral">"global_id"</span>: 2,</div>
<div class="line"> <span class="stringliteral">"template"</span>: <span class="stringliteral">"73"</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> ]</div>
<div class="line">}</div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- PageDoc -->
</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>