| <!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.8.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: Dnnl_api_sycl_interop</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">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <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'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <!-- 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="summary"> |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Dnnl_api_sycl_interop<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> » <a class="el" href="group__dnnl__api__interop.html">Dnnl_api_interop</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Collaboration diagram for Dnnl_api_sycl_interop:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="group__dnnl__api__sycl__interop.png" border="0" usemap="#group____dnnl____api____sycl____interop" alt=""/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:ga8315f93ce0f395f59420094f3456b96c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a> { <a class="el" href="group__dnnl__api__sycl__interop.html#gga8315f93ce0f395f59420094f3456b96caaabe6c0b7c6796f5fe800d455d65e05f">dnnl_sycl_interop_usm</a>, |
| <a class="el" href="group__dnnl__api__sycl__interop.html#gga8315f93ce0f395f59420094f3456b96ca08ce10b9e333a0c8f2f9463769c868ed">dnnl_sycl_interop_buffer</a> |
| }</td></tr> |
| <tr class="memdesc:ga8315f93ce0f395f59420094f3456b96c"><td class="mdescLeft"> </td><td class="mdescRight">Memory allocation kind. <a href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">More...</a><br /></td></tr> |
| <tr class="separator:ga8315f93ce0f395f59420094f3456b96c"><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:ga7d768ee527493380e13fdf2983b32b70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga7d768ee527493380e13fdf2983b32b70">dnnl_sycl_interop_engine_create</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> *engine, const void *device, const void *context)</td></tr> |
| <tr class="separator:ga7d768ee527493380e13fdf2983b32b70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga23b777c4d60c3dd9b542126973cb69a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga23b777c4d60c3dd9b542126973cb69a5">dnnl_sycl_interop_engine_get_context</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, void **context)</td></tr> |
| <tr class="separator:ga23b777c4d60c3dd9b542126973cb69a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf6a88b22743cc5ca54ad46ee88fbb71e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#gaf6a88b22743cc5ca54ad46ee88fbb71e">dnnl_sycl_interop_engine_get_device</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, void **device)</td></tr> |
| <tr class="separator:gaf6a88b22743cc5ca54ad46ee88fbb71e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac61a334ced53bf09f0887c53d4d771c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#gac61a334ced53bf09f0887c53d4d771c2">dnnl_sycl_interop_memory_create</a> (<a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> *memory, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *memory_desc, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, <a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a> memory_kind, void *handle)</td></tr> |
| <tr class="separator:gac61a334ced53bf09f0887c53d4d771c2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3c24bba041823efb72fd4ce003a4436c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga3c24bba041823efb72fd4ce003a4436c">dnnl_sycl_interop_memory_get_memory_kind</a> (<a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> memory, <a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a> *memory_kind)</td></tr> |
| <tr class="separator:ga3c24bba041823efb72fd4ce003a4436c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafc109d3058effed15055e7657f4840c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#gafc109d3058effed15055e7657f4840c1">dnnl_sycl_interop_memory_set_buffer</a> (<a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> memory, void *buffer, <a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream)</td></tr> |
| <tr class="separator:gafc109d3058effed15055e7657f4840c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga64dc62b1586d688afcd110840e570cd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga64dc62b1586d688afcd110840e570cd5">dnnl_sycl_interop_stream_create</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> *stream, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, void *queue)</td></tr> |
| <tr class="separator:ga64dc62b1586d688afcd110840e570cd5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab279fc3922a8b4ab59d4b328f1610172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#gab279fc3922a8b4ab59d4b328f1610172">dnnl_sycl_interop_stream_get_queue</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream, void **queue)</td></tr> |
| <tr class="separator:gab279fc3922a8b4ab59d4b328f1610172"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga49aea2229b2e3afcd66e31ef76fcbe64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__sycl__interop.html#ga49aea2229b2e3afcd66e31ef76fcbe64">dnnl_sycl_interop_primitive_execute</a> (<a class="el" href="group__dnnl__api__primitives__common.html#ga3a24919ac3820e4a196bd4e50a0972c5">const_dnnl_primitive_t</a> primitive, <a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream, int nargs, const <a class="el" href="structdnnl__exec__arg__t.html">dnnl_exec_arg_t</a> *args, const void *deps, void *return_event)</td></tr> |
| <tr class="separator:ga49aea2229b2e3afcd66e31ef76fcbe64"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="ga8315f93ce0f395f59420094f3456b96c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8315f93ce0f395f59420094f3456b96c">◆ </a></span>dnnl_sycl_interop_memory_kind_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Memory allocation kind. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga8315f93ce0f395f59420094f3456b96caaabe6c0b7c6796f5fe800d455d65e05f"></a>dnnl_sycl_interop_usm </td><td class="fielddoc"><p>USM (device, shared, host, or unknown) memory allocation kind - default. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga8315f93ce0f395f59420094f3456b96ca08ce10b9e333a0c8f2f9463769c868ed"></a>dnnl_sycl_interop_buffer </td><td class="fielddoc"><p>Buffer memory allocation kind. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ga7d768ee527493380e13fdf2983b32b70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga7d768ee527493380e13fdf2983b32b70">◆ </a></span>dnnl_sycl_interop_engine_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_engine_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> * </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>device</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>context</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an engine associated with a SYCL device and a SYCL context.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Output engine. </td></tr> |
| <tr><td class="paramname">device</td><td>Pointer to the SYCL device to use for the engine. </td></tr> |
| <tr><td class="paramname">context</td><td>Pointer to the SYCL context to use for the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga23b777c4d60c3dd9b542126973cb69a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga23b777c4d60c3dd9b542126973cb69a5">◆ </a></span>dnnl_sycl_interop_engine_get_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_engine_get_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void ** </td> |
| <td class="paramname"><em>context</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the SYCL context associated with an engine.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Engine to query. </td></tr> |
| <tr><td class="paramname">context</td><td>Pointer to the underlying SYCL context of the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gaf6a88b22743cc5ca54ad46ee88fbb71e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaf6a88b22743cc5ca54ad46ee88fbb71e">◆ </a></span>dnnl_sycl_interop_engine_get_device()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_engine_get_device </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void ** </td> |
| <td class="paramname"><em>device</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the SYCL device associated with an engine.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Engine to query. </td></tr> |
| <tr><td class="paramname">device</td><td>Pointer to the underlying SYCL device of the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gac61a334ced53bf09f0887c53d4d771c2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac61a334ced53bf09f0887c53d4d771c2">◆ </a></span>dnnl_sycl_interop_memory_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_memory_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> * </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td> |
| <td class="paramname"><em>memory_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a> </td> |
| <td class="paramname"><em>memory_kind</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>handle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates a memory object.</p> |
| <p>Unless <code>handle</code> is equal to DNNL_MEMORY_NONE or DNNL_MEMORY_ALLOCATE, the constructed memory object will have the underlying buffer set. In this case, the buffer will be initialized as if:</p><ul> |
| <li><a class="el" href="group__dnnl__api__memory.html#ga6888f8c17f272d6729c9bc258ed41fcf">dnnl_memory_set_data_handle()</a> had been called, if <code>memory_kind</code> is equal to dnnl_sycl_interop_usm, or</li> |
| <li><a class="el" href="group__dnnl__api__sycl__interop.html#gafc109d3058effed15055e7657f4840c1">dnnl_sycl_interop_memory_set_buffer()</a> has been called, if <code>memory_kind</code> is equal to dnnl_sycl_interop_buffer.</li> |
| </ul> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Output memory object. </td></tr> |
| <tr><td class="paramname">memory_desc</td><td>Memory descriptor. </td></tr> |
| <tr><td class="paramname">engine</td><td>Engine to use. </td></tr> |
| <tr><td class="paramname">memory_kind</td><td>Memory allocation kind to specify the type of handle. </td></tr> |
| <tr><td class="paramname">handle</td><td>Handle of the memory buffer to use as an underlying storage.<ul> |
| <li>A USM pointer to the user-allocated buffer. In this case the library doesn't own the buffer. Requires <code>memory_kind</code> to be equal to dnnl_sycl_interop_usm.</li> |
| <li>A pointer to SYCL buffer. In this case the library doesn't own the buffer. Requires <code>memory_kind</code> be equal to be equal to dnnl_sycl_interop_buffer.</li> |
| <li>The DNNL_MEMORY_ALLOCATE special value. Instructs the library to allocate the buffer that corresponds to the memory allocation kind <code>memory_kind</code> for the memory object. In this case the library owns the buffer.</li> |
| <li>The DNNL_MEMORY_NONE specific value. Instructs the library to create memory object without an underlying buffer. </li> |
| </ul> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga3c24bba041823efb72fd4ce003a4436c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3c24bba041823efb72fd4ce003a4436c">◆ </a></span>dnnl_sycl_interop_memory_get_memory_kind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_memory_get_memory_kind </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__sycl__interop.html#ga8315f93ce0f395f59420094f3456b96c">dnnl_sycl_interop_memory_kind_t</a> * </td> |
| <td class="paramname"><em>memory_kind</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the memory allocation kind associated with a memory object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Memory to query. </td></tr> |
| <tr><td class="paramname">memory_kind</td><td>Output underlying memory allocation kind of the memory object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gafc109d3058effed15055e7657f4840c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gafc109d3058effed15055e7657f4840c1">◆ </a></span>dnnl_sycl_interop_memory_set_buffer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_memory_set_buffer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Sets a SYCL buffer for a memory object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Memory object. </td></tr> |
| <tr><td class="paramname">buffer</td><td>SYCL buffer to be set in the memory object. </td></tr> |
| <tr><td class="paramname">stream</td><td>Stream to use to execute padding in. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga49aea2229b2e3afcd66e31ef76fcbe64"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga49aea2229b2e3afcd66e31ef76fcbe64">◆ </a></span>dnnl_sycl_interop_primitive_execute()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_primitive_execute </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__primitives__common.html#ga3a24919ac3820e4a196bd4e50a0972c5">const_dnnl_primitive_t</a> </td> |
| <td class="paramname"><em>primitive</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>nargs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__exec__arg__t.html">dnnl_exec_arg_t</a> * </td> |
| <td class="paramname"><em>args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>deps</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>return_event</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Executes computations specified by the primitive in a specified stream and returns a SYCL event.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">primitive</td><td>Primitive to execute. </td></tr> |
| <tr><td class="paramname">stream</td><td>Stream to use. </td></tr> |
| <tr><td class="paramname">nargs</td><td>Number of arguments. </td></tr> |
| <tr><td class="paramname">args</td><td>Array of arguments. Each argument is an <index, <a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd" title="A memory handle.">dnnl_memory_t</a>> pair. The index is one of the <code>DNNL_ARG_*</code> values such as <code>DNNL_ARG_SRC</code>. Unless runtime shapes are used (see <a class="el" href="group__dnnl__api__memory.html#gaa596c5a6102df77a550bad98f0d5cc12">DNNL_RUNTIME_DIM_VAL</a>), the memory object must have the same memory descriptor as that returned by <a class="el" href="group__dnnl__api__primitives__common.html#ga416464a8b3e898d8965a5f3c49d4cd54">dnnl_primitive_desc_query_md</a>(<a class="el" href="group__dnnl__api__primitives__common.html#gga9e5235563cf7cfc10fa89f415de98059ac7ecf09260d89d54ddd7f35c51a244da" title="memory desc of an execute argument">dnnl_query_exec_arg_md</a>, index). </td></tr> |
| <tr><td class="paramname">deps</td><td>A pointer to std::vector<sycl::event> that contains dependencies. </td></tr> |
| <tr><td class="paramname">return_event</td><td>Output event. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga64dc62b1586d688afcd110840e570cd5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga64dc62b1586d688afcd110840e570cd5">◆ </a></span>dnnl_sycl_interop_stream_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_stream_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>queue</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an execution stream for a given engine associated with a SYCL queue.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Output execution stream. </td></tr> |
| <tr><td class="paramname">engine</td><td>Engine to create the execution stream on. </td></tr> |
| <tr><td class="paramname">queue</td><td>SYCL queue to use. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gab279fc3922a8b4ab59d4b328f1610172"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gab279fc3922a8b4ab59d4b328f1610172">◆ </a></span>dnnl_sycl_interop_stream_get_queue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_sycl_interop_stream_get_queue </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void ** </td> |
| <td class="paramname"><em>queue</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the SYCL queue associated with an execution stream.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Execution stream to query. </td></tr> |
| <tr><td class="paramname">queue</td><td>Output SYCL command queue. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful.">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
