mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-14 18:12:05 +00:00
1f5c203079
Update C/C++ API docs to commit 52d4699
Co-authored-by: RyanUnderhill <RyanUnderhill@users.noreply.github.com>
144 lines
17 KiB
HTML
144 lines
17 KiB
HTML
<!-- HTML header for doxygen 1.9.2-->
|
|
<!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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OnnxRuntime: Class List</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>
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-156955408-1"></script><script type="text/javascript">"use strict"; window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-156955408-1'); </script> <script type="text/javascript" src="/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="/assets/js/just-the-docs.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>
|
|
<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="projectlogo"><img alt="Logo" src="ONNX_Runtime_logo - Docs.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">OnnxRuntime
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('annotated.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">Class List</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
|
|
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_ort.html" target="_self">Ort</a></td><td class="desc">All C++ Onnxruntime APIs are defined inside this namespace </td></tr>
|
|
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_ort_1_1detail.html" target="_self">detail</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1detail_1_1_allocated_free.html" target="_self">AllocatedFree</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_allocator.html" target="_self">Allocator</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_allocator_with_default_options.html" target="_self">AllocatorWithDefaultOptions</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_arena_cfg.html" target="_self">ArenaCfg</a></td><td class="desc">It is a structure that represents the configuration of an arena based allocator </td></tr>
|
|
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_base.html" target="_self">Base</a></td><td class="desc">Used internally by the C++ API. C++ wrapper types inherit from this </td></tr>
|
|
<tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_b_float16__t.html" target="_self">BFloat16_t</a></td><td class="desc">Bfloat16 (Brain Floating Point) data type </td></tr>
|
|
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_custom_op_api.html" target="_self">CustomOpApi</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_7_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_custom_op_base.html" target="_self">CustomOpBase</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_custom_op_domain.html" target="_self">CustomOpDomain</a></td><td class="desc">Custom Op Domain </td></tr>
|
|
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_env.html" target="_self">Env</a></td><td class="desc">The <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> (Environment) </td></tr>
|
|
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_exception.html" target="_self">Exception</a></td><td class="desc">All C++ methods that can fail will throw an exception of this type </td></tr>
|
|
<tr id="row_0_11_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_float16__t.html" target="_self">Float16_t</a></td><td class="desc">IEEE 754 half-precision floating point data type </td></tr>
|
|
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_global.html" target="_self">Global</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_13_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_io_binding.html" target="_self">IoBinding</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_map_type_info.html" target="_self">MapTypeInfo</a></td><td class="desc">Wrapper around <a class="el" href="group___global.html#gac87280b8593f74df62181b124d9a790d">OrtMapTypeInfo</a> </td></tr>
|
|
<tr id="row_0_15_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_memory_allocation.html" target="_self">MemoryAllocation</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_memory_info.html" target="_self">MemoryInfo</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_17_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_model_metadata.html" target="_self">ModelMetadata</a></td><td class="desc">Wrapper around <a class="el" href="group___global.html#ga60c3d77af832d0d7fa5e14636009b408">OrtModelMetadata</a> </td></tr>
|
|
<tr id="row_0_18_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_run_options.html" target="_self">RunOptions</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_19_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_sequence_type_info.html" target="_self">SequenceTypeInfo</a></td><td class="desc">Wrapper around <a class="el" href="group___global.html#ga3cf68e3a575b0330628f7955c4ec3388">OrtSequenceTypeInfo</a> </td></tr>
|
|
<tr id="row_0_20_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_session.html" target="_self">Session</a></td><td class="desc">Wrapper around <a class="el" href="group___global.html#ga5220ca3b3f0a31a01a3f15057c35cac6">OrtSession</a> </td></tr>
|
|
<tr id="row_0_21_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_session_options.html" target="_self">SessionOptions</a></td><td class="desc">Options object used when creating a new <a class="el" href="struct_ort_1_1_session.html" title="Wrapper around OrtSession.">Session</a> object </td></tr>
|
|
<tr id="row_0_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_tensor_type_and_shape_info.html" target="_self">TensorTypeAndShapeInfo</a></td><td class="desc">Wrapper around <a class="el" href="group___global.html#ga6af32c548904330b6bd7e8cba6e186c1">OrtTensorTypeAndShapeInfo</a> </td></tr>
|
|
<tr id="row_0_23_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_type_info.html" target="_self">TypeInfo</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_24_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_unowned.html" target="_self">Unowned</a></td><td class="desc">Wraps an object that inherits from <a class="el" href="struct_ort_1_1_base.html" title="Used internally by the C++ API. C++ wrapper types inherit from this.">Ort::Base</a> and stops it from deleting the contained pointer on destruction </td></tr>
|
|
<tr id="row_0_25_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_25_" class="arrow" onclick="toggleFolder('0_25_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_value.html" target="_self">Value</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_25_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_value_1_1_ort_sparse_values_param.html" target="_self">OrtSparseValuesParam</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_25_1_"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_1_1_value_1_1_shape.html" target="_self">Shape</a></td><td class="desc"></td></tr>
|
|
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_allocator.html" target="_self">OrtAllocator</a></td><td class="desc">Memory allocation interface </td></tr>
|
|
<tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_api.html" target="_self">OrtApi</a></td><td class="desc">The C API </td></tr>
|
|
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_api_base.html" target="_self">OrtApiBase</a></td><td class="desc">The helper interface to get the right version of <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a> </td></tr>
|
|
<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_c_u_d_a_provider_options.html" target="_self">OrtCUDAProviderOptions</a></td><td class="desc">CUDA Provider Options </td></tr>
|
|
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_custom_handle_type.html" target="_self">OrtCustomHandleType</a></td><td class="desc"></td></tr>
|
|
<tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_custom_op.html" target="_self">OrtCustomOp</a></td><td class="desc"></td></tr>
|
|
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_m_i_graph_x_provider_options.html" target="_self">OrtMIGraphXProviderOptions</a></td><td class="desc">MIGraphX Provider Options </td></tr>
|
|
<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_open_v_i_n_o_provider_options.html" target="_self">OrtOpenVINOProviderOptions</a></td><td class="desc">OpenVINO Provider Options </td></tr>
|
|
<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_r_o_c_m_provider_options.html" target="_self">OrtROCMProviderOptions</a></td><td class="desc">ROCM Provider Options </td></tr>
|
|
<tr id="row_10_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_ort_tensor_r_t_provider_options.html" target="_self">OrtTensorRTProviderOptions</a></td><td class="desc">TensorRT Provider Options </td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</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.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|