-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathAPI-reference.html
executable file
·235 lines (198 loc) · 9.56 KB
/
API-reference.html
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>API reference</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/extra_frontend.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/nnstreamer_logo.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/nnstreamer_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
API References<span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="doc-index.html">NNStreamer doc</a>
</li>
<li>
<a href="gst/nnstreamer/README.html">NNStreamer Elements</a>
</li>
<li>
<a href="nnstreamer-example/index.html">NNStreamer Examples</a>
</li>
<li>
<a href="API-reference.html">API reference</a>
</li>
</ul>
</li>
<li>
<a href="doc-index.html">Documents</a>
</li>
<li>
<a href="gst/nnstreamer/README.html">Elements</a>
</li>
<li>
<a href="tutorials.html">Tutorials</a>
</li>
<li>
<a href="API-reference.html">API reference</a>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="NNStreamer" data-hotdoc-ref="API-reference.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h3 id="nnstreamer-doxygen-book"><a href="http://ci.nnstreamer.ai/nnstreamer/html/index.html">NNStreamer Doxygen book</a></h3>
<p><a href="http://ci.nnstreamer.ai/nnstreamer/html/index.html">NNStreamer Doxygen book</a> provides documents generated by doxygen comments of nnstreamer's source code.
If you are investigating the internals of nnstreamer, this document might be helpful.</p>
<h3 id="tizen-machinelearning-native-api-reference"><a href="https://docs.tizen.org/application/native/guides/machine-learning/overview/">Tizen Machine-Learning Native API reference</a></h3>
<p>NNStreamer is acting as the library to execute inferences in Tizen; in other words, NNStreamer is the implementation of the Tizen's MachineLearning.Inference APIs.
<a href="https://docs.tizen.org/application/native/guides/machine-learning/overview/">This link</a> provides native APIs (C-APIs) for Tizen Machine Learning.
In this document, the "inference.single" and "inference.pipeline" are implemented by NNStreamer.
MachineLearning.Inference.Single allows using subplugins of <code>tensor_filter</code> to run the given neural network model, invoking the model directly from the application with a single-shot input data.
MachineLearning.Inference.Pipeline allows describing and executing GStreamer pipelines including NNStreamer elements.
Note that MachineLearning.Training and MachineLearning.Service are implemented by other packages in this organization.</p>
<p>This API's main target is Tizen, but it supports other OS as well.</p>
<ul>
<li>
<a href="https://github.com/nnstreamer/api/tree/main/c">Implementation</a> (stable, since Tizen 5.5 M2)</li>
</ul>
<p>If you are writing Tizen applications in C/C++ along with neural network inferences, you are supposed to use Tizen Machine-Learning.Inference Native APIs.</p>
<h3 id="tizen-machinelearning-net-api-reference"><a href="https://docs.tizen.org/application/dotnet/guides/machine-learning/overview/">Tizen Machine-Learning .NET API reference</a></h3>
<p>If you are writing Tizen applications in .NET along with neural network inferences, you are supposed to use Tizen Machine-Learning.Inference.Singleshot/Pipeline .NET APIs.
The subdomains have the same roles as in Native APIs.</p>
<p>This API's main target is Tizen, but it supports other OS as well.</p>
<ul>
<li>
<a href="https://github.com/Samsung/TizenFX/tree/master/src/Tizen.MachineLearning.Inference">Implementation</a>
<ul>
<li>Single API: Tizen 5.5 M2</li>
<li>Pipeline API: Tizen 6.0 M1</li>
</ul>
</li>
</ul>
<h3 id="tizen-machinelearning-web-api-reference"><a href="https://docs.tizen.org/application/web/guides/machine-learning/overview/">Tizen Machine-Learning Web API reference</a></h3>
<p>If you are writing Tizen web applications along with neural network inferences, you are supposed to use Tizen Machine-Learning.Inference.Single/Pipeline Web APIs.
The subdomains have the same roles as in Native APIs.</p>
<ul>
<li>Web API (HTML5) (stable, since Tizen 6.5 M2)
<ul>
<li>
<a href="https://git.tizen.org/cgit/platform/core/api/webapi-plugins/tree/src/ml?h=tizen">Implementation</a> Tizen Web API</li>
</ul>
</li>
</ul>
<h3 id="android-java-api-reference"><a href="http://ci.nnstreamer.ai/nnstreamer/ci/daily-build/build_result/latest/java_html/index.html">Android Java API reference</a></h3>
<p>We provide Java APIs for Android applications.
Note that this supports SingleShot/Pipeline subdomains and do not include training or ML-service capabilities.</p>
<ul>
<li>
<a href="https://github.com/nnstreamer/nnstreamer-example/tree/master/android/example_app/api-sample">Android sample app</a> uses JAVA APIs to implement Android-NNStreamer apps.
<ul>
<li>Note that the Android Sample Applications published via Google Play Store, <a href="https://github.com/nnstreamer/nnstreamer-example/tree/main/android/example_app">Source Code</a>, are developed before NNStreamer Java API. They use GStreamer functions.</li>
</ul>
</li>
<li>
<a href="https://github.com/nnstreamer/api/tree/main/java">Implementation</a> (stable)</li>
<li><a href="https://bintray.com/beta/#/nnsuite/nnstreamer?tab=packages">Available at JCenter</a></li>
</ul>
<h3 id="python-api-is-planned">Python API is planned</h3>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>