-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathapi_config.html
More file actions
135 lines (133 loc) · 8.94 KB
/
api_config.html
File metadata and controls
135 lines (133 loc) · 8.94 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
<!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 Configuration</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_config.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 Configuration </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>RL Inference API can be configured using cfg::configuration. configuration is a collection of (name,value) config settings. They can be setup manually as follows: </p><div class="fragment"><div class="line">cfg::configuration cc;</div>
<div class="line">cc.set(<span class="stringliteral">"appid"</span>, <span class="stringliteral">"062618a"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"model.blob.uri"</span>, <span class="stringliteral">"https://<storage>.blob.core.windows.net/mwt-models/currebnt?sv=2017-07-29&sr=b&sig=<sig>&st=2018-06-26T09%3A00%3A55Z&se=2028-06-26T09%3A01%3A55Z&sp=r"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"interaction.eventhub.key"</span>, <span class="stringliteral">"<SAKey>"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"interaction.eventhub.name"</span>, <span class="stringliteral">"interaction"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"initial_exploration.epsilon"</span>, <span class="stringliteral">"1"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"interaction.eventhub.host"</span>, <span class="stringliteral">"<ingest>.servicebus.windows.net"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"observation.eventhub.host"</span>, <span class="stringliteral">"<ingest>.servicebus.windows.net"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"interaction.eventhub.keyname"</span>, <span class="stringliteral">"RootManageSharedAccessKey"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"observation.eventhub.name"</span>, <span class="stringliteral">"observation"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"observation.eventhub.keyname"</span>, <span class="stringliteral">"RootManageSharedAccessKey"</span>);</div>
<div class="line">cc.set(<span class="stringliteral">"observation.eventhub.key"</span>, <span class="stringliteral">"<SAKey>"</span>);</div>
</div><!-- fragment --><p>configuration can also be loaded from a config file associated with the online trainer in Azure. The client.json config file has the following format: </p><div class="fragment"><div class="line">{</div>
<div class="line"> <span class="stringliteral">"ApplicationID"</span>: <span class="stringliteral">"<appid>"</span>,</div>
<div class="line"> <span class="stringliteral">"EventHubInteractionConnectionString"</span>: <span class="stringliteral">"Endpoint=sb://<ingest>.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=<SAKey>;EntityPath=interaction"</span>,</div>
<div class="line"> <span class="stringliteral">"EventHubObservationConnectionString"</span>: <span class="stringliteral">"Endpoint=sb://<ingest>.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=<SAKey>;EntityPath=observation"</span>,</div>
<div class="line"> <span class="stringliteral">"IsExplorationEnabled"</span>: <span class="keyword">true</span>,</div>
<div class="line"> <span class="stringliteral">"ModelBlobUri"</span>: <span class="stringliteral">"https://<storage>.blob.core.windows.net/mwt-models/current?sv=2017-07-29&sr=b&sig=<sig>&st=2018-06-26T09%3A00%3A55Z&se=2028-06-26T09%3A01%3A55Z&sp=r"</span>,</div>
<div class="line"> <span class="stringliteral">"AppInsightsKey"</span>: <span class="stringliteral">"<AppInsightsKey>"</span>,</div>
<div class="line"> <span class="stringliteral">"InitialExplorationEpsilon"</span>: 1.0</div>
<div class="line">}</div>
</div><!-- fragment --><p>Initialize a configuration from a json string: </p><div class="fragment"><div class="line"> <span class="comment">// Use library supplied convenience method to parse json and build config object</span></div>
<div class="line"> <span class="comment">// namespace cfg=reinforcement_learning::utility::config;</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> cfg::create_from_json(config_str, config);</div>
</div><!-- fragment --><p> Instantiate Inference API using config: </p><div class="fragment"><div class="line"> r::cb_loop rl(config);</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>