onnxruntime/docs/api/java/ai/onnxruntime/TensorInfo.html
Cassie a0f3e30de6
Docs update: updated nav, get started sections, home page, apis (#9060)
* initial setup and rename "how to" to "setup"

* move API to main nav

* move api to main nav

* add get starated, rework nav order

* rename to install move mds out of install section

* update api nav and home page

* add install docs and python qs updates

* python get started work

* remove c and obj c for now

* move java, python, and obj-c docs under api folder

* move java api html to iframe (ugh)

* remove api docs w/o details, move api text getstar

* remove api docs wo detail updates get started

* remvoe iframes

* move eco system to main nav

* fix api buttons

* added more examples moved intro to ORT

* fix links

* fix get started titles

* fix get started titles

* fix more links

* fix more links

* more link fixes

* fix nav remove inferencing and training subnav

* fix top nav remove inference and training nav

* fix title

* fix tutorials nav hierarchy

* fix python api button

* add tenorflow keras example

* fix quickstart toc

* add imports fix spacing

* fix links

* update nav and python get started page

* move ort training example, add coming soon for iot

* update C# get started

* fix spacing on quantization

* Add some js get started content

* fix formatting

* fix typo

* removed onnx-pytorch and onnx-tf

* updated pip install torch and added links iot page

* added pytorch tutorial heirarchy

* updated web to docs soon added release blog link

* add web link
2021-09-15 16:23:42 -05:00

462 lines
18 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_221) on Fri Dec 06 15:15:32 EST 2019 -->
<title>TensorInfo (OnnxRuntime-Java-API)</title>
<meta name="date" content="2019-12-06">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TensorInfo (OnnxRuntime-Java-API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TensorInfo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../ai/onnxruntime/SequenceInfo.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/TensorInfo.html" target="_top">Frames</a></li>
<li><a href="TensorInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ai.onnxruntime</div>
<h2 title="Class TensorInfo" class="title">Class TensorInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.TensorInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../ai/onnxruntime/ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TensorInfo</span>
extends java.lang.Object
implements <a href="../../ai/onnxruntime/ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></pre>
<div class="block">Describes an <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime"><code>OnnxTensor</code></a>, including it's size, shape and element type.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a></span></code>
<div class="block">The native element types supported by the ONNX runtime.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#MAX_DIMENSIONS">MAX_DIMENSIONS</a></span></code>
<div class="block">Maximum number of dimensions supported by the Java interface methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#onnxType">onnxType</a></span></code>
<div class="block">The native type of this tensor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#type">type</a></span></code>
<div class="block">The Java type of this tensor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#constructFromBuffer-java.nio.Buffer-long:A-ai.onnxruntime.OnnxJavaType-">constructFromBuffer</a></span>(java.nio.Buffer&nbsp;buffer,
long[]&nbsp;shape,
<a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)</code>
<div class="block">Constructs a TensorInfo from the supplied byte buffer.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#constructFromJavaArray-java.lang.Object-">constructFromJavaArray</a></span>(java.lang.Object&nbsp;obj)</code>
<div class="block">Constructs a TensorInfo from the supplied multidimensional Java array,
used to allocate the appropriate amount of native memory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#getShape--">getShape</a></span>()</code>
<div class="block">Get a copy of the tensor's shape.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#isScalar--">isScalar</a></span>()</code>
<div class="block">Returns true if the shape represents a scalar value (i.e.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#makeCarrier--">makeCarrier</a></span>()</code>
<div class="block">Constructs an array the right shape and type to hold this tensor.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/TensorInfo.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MAX_DIMENSIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_DIMENSIONS</h4>
<pre>public static final&nbsp;int MAX_DIMENSIONS</pre>
<div class="block">Maximum number of dimensions supported by the Java interface methods.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#ai.onnxruntime.TensorInfo.MAX_DIMENSIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public final&nbsp;<a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a> type</pre>
<div class="block">The Java type of this tensor.</div>
</li>
</ul>
<a name="onnxType">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onnxType</h4>
<pre>public final&nbsp;<a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a> onnxType</pre>
<div class="block">The native type of this tensor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getShape--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShape</h4>
<pre>public&nbsp;long[]&nbsp;getShape()</pre>
<div class="block">Get a copy of the tensor's shape.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of the tensor's shape.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="isScalar--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isScalar</h4>
<pre>public&nbsp;boolean&nbsp;isScalar()</pre>
<div class="block">Returns true if the shape represents a scalar value (i.e. it has zero dimensions).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the shape is a scalar.</dd>
</dl>
</li>
</ul>
<a name="makeCarrier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeCarrier</h4>
<pre>public&nbsp;java.lang.Object&nbsp;makeCarrier()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs an array the right shape and type to hold this tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A multidimensional array of the appropriate primitive type (or String).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the shape isn't representable in Java (i.e. if one of it's indices is greater than an int).</dd>
</dl>
</li>
</ul>
<a name="constructFromJavaArray-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructFromJavaArray</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;constructFromJavaArray(java.lang.Object&nbsp;obj)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs a TensorInfo from the supplied multidimensional Java array,
used to allocate the appropriate amount of native memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - The object to inspect.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TensorInfo which can be used to make the right size Tensor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the supplied Object isn't an array, or is an invalid type.</dd>
</dl>
</li>
</ul>
<a name="constructFromBuffer-java.nio.Buffer-long:A-ai.onnxruntime.OnnxJavaType-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>constructFromBuffer</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;constructFromBuffer(java.nio.Buffer&nbsp;buffer,
long[]&nbsp;shape,
<a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs a TensorInfo from the supplied byte buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to inspect.</dd>
<dd><code>shape</code> - The shape of the tensor.</dd>
<dd><code>type</code> - The Java type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TensorInfo for a tensor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the supplied buffer doesn't match the shape.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TensorInfo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../ai/onnxruntime/SequenceInfo.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/TensorInfo.html" target="_top">Frames</a></li>
<li><a href="TensorInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>