saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/c/deprecated.html

167 lines
18 KiB
HTML
Raw Normal View History

[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<!-- HTML header for doxygen -->
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<!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"/>
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<meta name="generator" content="Doxygen 1.9.6"/>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OnnxRuntime: Deprecated 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>
Update C/C++ API docs to commit d52d3c0 (#10222) Co-authored-by: natke <natke@users.noreply.github.com>
2022-01-08 00:25:57 +00:00
<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>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<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 -->
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<!-- Generated by Doxygen 1.9.6 -->
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
var searchBox = new SearchBox("searchBox", "search/",'.html');
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
/* @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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('deprecated.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">
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
</div>
<div><div class="header">
<div class="headertitle"><div class="title">Deprecated List </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="reflist">
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#ae39a4bb631faea94364121264fb0c7d3">Ort::CustomOpApi::CopyKernelInfo</a> (const OrtKernelInfo *info)</dt>
<dd><a class="anchor" id="_deprecated000027"></a>use <a class="el" href="struct_ort_1_1detail_1_1_kernel_info_impl.html#a481ea24d380e077ba3bbaf6431467b5f">Ort::KernelInfo::Copy</a> querying attributes [[deprecated]] This interface is not exception safe </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a8c66daa44131353c1ba93ed41078f320">Ort::CustomOpApi::CreateOp</a> (const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, int type_constraint_count, const OrtOpAttr *const *attr_values, int attr_count, int input_count, int output_count)</dt>
<dd><a class="anchor" id="_deprecated000023"></a>use <a class="el" href="struct_ort_1_1_op.html" title="Create and own custom defined operation.">Ort::Op</a> [[deprecated]] This interface is not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a2740576ee3310312e198533bd9f0fddb">Ort::CustomOpApi::CreateOpAttr</a> (const char *name, const void *data, int len, OrtOpAttrType type)</dt>
<dd><a class="anchor" id="_deprecated000021"></a>use <a class="el" href="struct_ort_1_1_op_attr.html" title="This struct provides life time management for custom op attribute.">Ort::OpAttr</a> [[deprecated]] This interface is not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a53dbeeb8fba97a7c5c1e5a97a8f1978a">Ort::CustomOpApi::GetDimensions</a> (const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)</dt>
<dd><a class="anchor" id="_deprecated000008"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a553b1d07adab289060c143086b1be32d" title="Uses GetDimensionsCount &amp; GetDimensions to return a std::vector of the shape.">Ort::TensorTypeAndShapeInfo::GetShape()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a09e1878a345d126e64b59e193fc06050">Ort::CustomOpApi::GetDimensionsCount</a> (const OrtTensorTypeAndShapeInfo *info)</dt>
<dd><a class="anchor" id="_deprecated000007"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a93e0ba7d39a37a62613c945e6c6ace60" title="Wraps OrtApi::GetDimensionsCount.">Ort::TensorTypeAndShapeInfo::GetDimensionsCount()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#afd1a695491b0cd72147170e6ff28ef61">Ort::CustomOpApi::GetTensorData</a> (const OrtValue *value)</dt>
<dd><a class="anchor" id="_deprecated000011"></a>use <a class="el" href="struct_ort_1_1detail_1_1_const_value_impl.html#aed947feb6d46847d3d6cc0289b377fe6" title="Returns a const typed pointer to the tensor contained data. No type checking is performed,...">Ort::Value::GetTensorData()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a880d0346b32ddada9c42dad22898ee20">Ort::CustomOpApi::GetTensorElementType</a> (const OrtTensorTypeAndShapeInfo *info)</dt>
<dd><a class="anchor" id="_deprecated000006"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#ad38e0ee012301ec3fdfb680c3f26f4cf" title="Wraps OrtApi::GetTensorElementType.">Ort::TensorTypeAndShapeInfo::GetElementType()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#afb1a70a3d307af25e828b35bcf5f04b8">Ort::CustomOpApi::GetTensorMemoryInfo</a> (const OrtValue *value)</dt>
<dd><a class="anchor" id="_deprecated000012"></a>use <a class="el" href="struct_ort_1_1detail_1_1_const_value_impl.html#a7342c33f055407202f6b0e4ed209ead0" title="This API returns information about the memory allocation used to hold data.">Ort::Value::GetTensorMemoryInfo()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#af9e61c4eb4c8f906b0e82671913e1980">Ort::CustomOpApi::GetTensorMutableData</a> (OrtValue *value)</dt>
<dd><a class="anchor" id="_deprecated000010"></a>use <a class="el" href="struct_ort_1_1detail_1_1_value_impl.html#a28317ae875d9c8b35f0cbed64f776c5a" title="Returns a non-const typed pointer to an OrtValue/Tensor contained buffer No type checking is performe...">Ort::Value::GetTensorMutableData()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a4c60b4f47540791b366228dd6f790a7c">Ort::CustomOpApi::GetTensorShape</a> (const OrtTensorTypeAndShapeInfo *info)</dt>
<dd><a class="anchor" id="_deprecated000013"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a553b1d07adab289060c143086b1be32d" title="Uses GetDimensionsCount &amp; GetDimensions to return a std::vector of the shape.">Ort::TensorTypeAndShapeInfo::GetShape()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a769b23926ee250807eda73df88746bc9">Ort::CustomOpApi::GetTensorShapeElementCount</a> (const OrtTensorTypeAndShapeInfo *info)</dt>
<dd><a class="anchor" id="_deprecated000005"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a147b9d073f3f28d5ad4ea4edc3d8d1ca" title="Wraps OrtApi::GetTensorShapeElementCount.">Ort::TensorTypeAndShapeInfo::GetElementCount()</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a4bac2252005fbe045acb35090a545a3d">Ort::CustomOpApi::GetTensorTypeAndShape</a> (const OrtValue *value)</dt>
<dd><a class="anchor" id="_deprecated000004"></a>use Ort::Value::GetTensorTypeAndShape() [[deprecated]] This interface produces a pointer that must be released. Not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a17cae29d7ef679bae9b9b0857b188b45">Ort::CustomOpApi::InvokeOp</a> (const OrtKernelContext *context, const OrtOp *ort_op, const OrtValue *const *input_values, int input_count, OrtValue *const *output_values, int output_count)</dt>
<dd><a class="anchor" id="_deprecated000024"></a>use <a class="el" href="struct_ort_1_1_op.html#adb82cf8dbb13a397bab27505595576fb">Ort::Op::Invoke</a> [[deprecated]] This interface is redundant </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a0bb133692d307824f5da57019963d4a2">Ort::CustomOpApi::KernelContext_GetGPUComputeStream</a> (const OrtKernelContext *context)</dt>
<dd><a class="anchor" id="_deprecated000019"></a>use <a class="el" href="struct_ort_1_1_kernel_context.html#a9a43f9088473124a4d62a0815761650e">Ort::KernelContext::GetGPUComputeStream</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#afa21769ea0c1dca10da330d4d4544baa">Ort::CustomOpApi::KernelContext_GetInput</a> (const OrtKernelContext *context, size_t index)</dt>
<dd><a class="anchor" id="_deprecated000016"></a>use <a class="el" href="struct_ort_1_1_kernel_context.html#a35f4a366b022bfa6d4dd3d3837d87e3a">Ort::KernelContext::GetInput</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a17348789cfde3e1a93bf1e2af67c183e">Ort::CustomOpApi::KernelContext_GetInputCount</a> (const OrtKernelContext *context)</dt>
<dd><a class="anchor" id="_deprecated000015"></a>use <a class="el" href="struct_ort_1_1_kernel_context.html#a9b6d52cd982f7684db27f97905e3871e">Ort::KernelContext::GetInputCount</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a3ee901b1e84cc4c47221dc230d357b66">Ort::CustomOpApi::KernelContext_GetOutput</a> (OrtKernelContext *context, size_t index, const int64_t *dim_values, size_t dim_count)</dt>
<dd><a class="anchor" id="_deprecated000018"></a>use <a class="el" href="struct_ort_1_1_kernel_context.html#ac0aefe2c01dc8b2c3ec8f12458707003">Ort::KernelContext::GetOutput</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a015cb844d1127a400228c2756892d453">Ort::CustomOpApi::KernelContext_GetOutputCount</a> (const OrtKernelContext *context)</dt>
<dd><a class="anchor" id="_deprecated000017"></a>use <a class="el" href="struct_ort_1_1_kernel_context.html#aac4e8ec24fb1f67147ffed82f973fd30">Ort::KernelContext::GetOutputCount</a> [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a47632080bea3d198cc8036e6c57a9288">Ort::CustomOpApi::KernelInfoGetAttribute</a> (const OrtKernelInfo *info, const char *name)</dt>
<dd><a class="anchor" id="_deprecated000026"></a>use <a class="el" href="struct_ort_1_1_kernel_info.html" title="This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...">Ort::KernelInfo</a> for automatic lifespan management or for querying attributes [[deprecated]] This interface is redundant </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#af74d63c508411150a9c905824e9ee95b">Ort::CustomOpApi::ReleaseKernelInfo</a> (OrtKernelInfo *info_copy)</dt>
<dd><a class="anchor" id="_deprecated000028"></a>use <a class="el" href="struct_ort_1_1_kernel_info.html" title="This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...">Ort::KernelInfo</a> for lifespan management querying attributes [[deprecated]] This interface is not exception safe </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a31dc7e04f29cfa16413f22198ecd824e">Ort::CustomOpApi::ReleaseOp</a> (OrtOp *ort_op)</dt>
<dd><a class="anchor" id="_deprecated000025"></a>use <a class="el" href="struct_ort_1_1_op.html" title="Create and own custom defined operation.">Ort::Op</a> for automatic lifespan management. [[deprecated]] This interface is not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a5c929d4036f582b452ce4bc9b8633c86">Ort::CustomOpApi::ReleaseOpAttr</a> (OrtOpAttr *op_attr)</dt>
<dd><a class="anchor" id="_deprecated000022"></a>use <a class="el" href="struct_ort_1_1_op_attr.html" title="This struct provides life time management for custom op attribute.">Ort::OpAttr</a> [[deprecated]] This interface is not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a42981ee288830f4b60683bbd4a21627d">Ort::CustomOpApi::ReleaseTensorTypeAndShapeInfo</a> (OrtTensorTypeAndShapeInfo *input)</dt>
<dd><a class="anchor" id="_deprecated000014"></a>use <a class="el" href="struct_ort_1_1_tensor_type_and_shape_info.html" title="Wrapper around OrtTensorTypeAndShapeInfo.">TensorTypeAndShapeInfo</a> instances for automatic ownership. [[deprecated]] This interface is not exception safe. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#ad5fd03a24b54f6a42dc1660499d789e1">Ort::CustomOpApi::SetDimensions</a> (OrtTensorTypeAndShapeInfo *info, const int64_t *dim_values, size_t dim_count)</dt>
<dd><a class="anchor" id="_deprecated000009"></a> [[deprecated]] This interface sets dimensions to <a class="el" href="struct_ort_1_1_tensor_type_and_shape_info.html" title="Wrapper around OrtTensorTypeAndShapeInfo.">TensorTypeAndShapeInfo</a>, but has no effect on the OrtValue. </dd>
<dt>Member <a class="el" href="struct_ort_1_1_custom_op_api.html#a5e6b792b3e87a2c4fcf79d9e8bf3773c">Ort::CustomOpApi::ThrowOnError</a> (OrtStatus *result)</dt>
<dd><a class="anchor" id="_deprecated000020"></a>use Ort::ThrowOnError() [[deprecated]] This interface is redundant. </dd>
<dt>Member <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a2ee1c58378c53d42ea1c023513ab3a6c">Ort::detail::TensorTypeAndShapeInfoImpl&lt; T &gt;::GetDimensions</a> (int64_t *values, size_t values_count) const</dt>
<dd><a class="anchor" id="_deprecated000003"></a>use <a class="el" href="struct_ort_1_1detail_1_1_tensor_type_and_shape_info_impl.html#a553b1d07adab289060c143086b1be32d" title="Uses GetDimensionsCount &amp; GetDimensions to return a std::vector of the shape.">GetShape()</a> returning std::vector [[deprecated]] This interface is unsafe to use </dd>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<dt>Member <a class="el" href="struct_ort_api.html#a8f434054a695048e551109ad1166b6b3">OrtApi::CreateArenaCfg</a> (size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk, OrtArenaCfg **out)</dt>
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<dd><a class="anchor" id="_deprecated000002"></a>Use <a class="el" href="struct_ort_api.html#a8cb2e18f00a20d076212102177abc00c" title="Create an OrtArenaCfg.">OrtApi::CreateArenaCfgV2</a> </dd>
<dt>Member <a class="el" href="struct_ort_api.html#a4dc58d1aa01d67494a3fb4ce00e9a929">OrtApi::RegisterCustomOpsLibrary</a> (OrtSessionOptions *options, const char *library_path, void **library_handle)</dt>
<dd><a class="anchor" id="_deprecated000001"></a>Use <a class="el" href="struct_ort_api.html#aac452645b29bbe2ff9996cc950fa5ecd" title="Register custom ops from a shared library.">OrtApi::RegisterCustomOpsLibrary_V2</a>.</dd>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
</dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
[Automated]: Update C/C++ API docs (#14568) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-04 01:20:27 +00:00
<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.6 </li>
Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
</ul>
</div>
</body>
</html>
Reference in a new issue Copy permalink