Skip to content

Commit d883059

Browse files
Remove dead links
1 parent bf0bd9c commit d883059

File tree

3 files changed

+34
-35
lines changed

3 files changed

+34
-35
lines changed

docs/execution-providers/community-maintained/CANN-ExecutionProvider.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,4 +389,3 @@ Following ops are supported by the CANN Execution Provider in single-operator In
389389
Additional operator support and performance tuning will be added soon.
390390
391391
* [Ascend](https://www.hiascend.com/en/)
392-
* [CANN](https://www.hiascend.com/en/software/cann)

docs/execution-providers/plugin-ep-libraries.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,25 @@ The following table lists the **required** varibles and functions that an implem
3838
</tr>
3939

4040
<tr>
41-
<td><a href="#c-api-ort-ep-ort-version-supported">ort_version_supported</a></td>
41+
<td>ort_version_supported</td>
4242
<td>The ONNX Runtime version with which the EP was compiled. Implementation should set to <code>ORT_API_VERSION</code>.</td>
4343
<td><a href="https://github.com/microsoft/onnxruntime/blob/16ae99ede405d3d6c59d7cce80c53f5f7055aeed/onnxruntime/test/autoep/library/ep.cc#L160">ExampleEp()</a></td>
4444
</tr>
4545

4646
<tr>
47-
<td><a href="#c-api-ort-ep-get-name">GetName</a></td>
47+
<td>GetName</td>
4848
<td>Get the execution provider name.</td>
4949
<td><a href="https://github.com/microsoft/onnxruntime/blob/16ae99ede405d3d6c59d7cce80c53f5f7055aeed/onnxruntime/test/autoep/library/ep.cc#L181">ExampleEp::GetNameImpl()</a></td>
5050
</tr>
5151

5252
<tr>
53-
<td><a href="#c-api-ort-ep-get-capability">GetCapability</a></td>
53+
<td>GetCapability</td>
5454
<td>Get information about the nodes/subgraphs supported by the <code>OrtEp</code> instance.</td>
5555
<td><a href="https://github.com/microsoft/onnxruntime/blob/16ae99ede405d3d6c59d7cce80c53f5f7055aeed/onnxruntime/test/autoep/library/ep.cc#L231">ExampleEp::GetCapabilityImpl()</a></td>
5656
</tr>
5757

5858
<tr>
59-
<td><a href="#c-api-ort-ep-compile">Compile</a></td>
59+
<td>Compile</td>
6060
<td>
6161
Compile <code>OrtGraph</code> instances assigned to the <code>OrtEp</code>. Implementation must set a <code>OrtNodeComputeInfo</code> instance for each <code>OrtGraph</code> in order to define its computation function.<br/><br/>
6262
If the session is configured to generate a pre-compiled model, the execution provider must return <code>count</code> number of EPContext nodes.
@@ -65,7 +65,7 @@ If the session is configured to generate a pre-compiled model, the execution pro
6565
</tr>
6666

6767
<tr>
68-
<td><a href="c-api-ort-ep-release-node-compute-infos">ReleaseNodeComputeInfos</a></td>
68+
<td>ReleaseNodeComputeInfos</td>
6969
<td>
7070
Release <code>OrtNodeComputeInfo</code> instances.
7171
</td>
@@ -84,7 +84,7 @@ The following table lists the **optional** functions that an implementor may def
8484
</tr>
8585

8686
<tr>
87-
<td><a href="c-api-ort-ep-get-preferred-data-layout">GetPreferredDataLayout</a></td>
87+
<td>GetPreferredDataLayout</td>
8888
<td>
8989
Get the EP's preferred data layout.<br/><br/>
9090
If this function is not implemented, ORT assumes that the EP prefers the data layout <code>OrtEpDataLayout::NCHW</code>.
@@ -93,7 +93,7 @@ If this function is not implemented, ORT assumes that the EP prefers the data la
9393
</tr>
9494

9595
<tr>
96-
<td><a href="c-api-ort-ep-should-convert-data-layout-for-op">ShouldConvertDataLayoutForOp</a></td>
96+
<td>ShouldConvertDataLayoutForOp</td>
9797
<td>
9898
Given an op with domain <code>domain</code> and type <code>op_type</code>, determine whether an associated node's data layout should be converted to a <code>target_data_layout</code>. If the EP prefers a non-default data layout, this function will be called during layout transformation with <code>target_data_layout</code> set to the EP's preferred data layout<br/><br/>
9999
Implementation of this function is optional. If an EP prefers a non-default data layout, it may implement this to customize the specific op data layout preferences at a finer granularity.
@@ -102,7 +102,7 @@ Implementation of this function is optional. If an EP prefers a non-default data
102102
</tr>
103103

104104
<tr>
105-
<td><a href="c-api-ort-ep-set-dynamic-options">SetDynamicOptions</a></td>
105+
<td>SetDynamicOptions</td>
106106
<td>
107107
Set dynamic options on this EP. Dynamic options can be set by the application at any time after session creation with <a href="https://onnxruntime.ai/docs/api/c/struct_ort_api.html#ab1117a51683e4fbb42687c9db6e8d5fb"><code>OrtApi::SetEpDynamicOptions()</code></a>.<br/><br/>
108108
Implementation of this function is optional. An EP should only impliment this function if it needs to handle any dynamic options.
@@ -111,7 +111,7 @@ Implementation of this function is optional. An EP should only impliment this fu
111111
</tr>
112112

113113
<tr>
114-
<td><a href="c-api-ort-ep-on-run-start">OnRunStart</a></td>
114+
<td>OnRunStart</td>
115115
<td>
116116
Called by ORT to notify the EP of the start of a run.<br/><br/>
117117
Implementation of this function is optional. An EP should only impliment this function if it needs to handle application-provided options at the start of a run.
@@ -120,7 +120,7 @@ Implementation of this function is optional. An EP should only impliment this fu
120120
</tr>
121121

122122
<tr>
123-
<td><a href="c-api-ort-ep-on-run-end">OnRunEnd</a></td>
123+
<td>OnRunEnd</td>
124124
<td>
125125
Called by ORT to notify the EP of the end of a run.<br/><br/>
126126
Implementation of this function is optional. An EP should only impliment this function if it needs to handle application-provided options at the end of a run.
@@ -129,7 +129,7 @@ Implementation of this function is optional. An EP should only impliment this fu
129129
</tr>
130130

131131
<tr>
132-
<td><a href="c-api-ort-ep-create-allocator">CreateAllocator</a></td>
132+
<td>CreateAllocator</td>
133133
<td>
134134
Create an <code>OrtAllocator</code> for the given <code>OrtMemoryInfo</code> for an <code>OrtSession</code>.<br/><br/>The <code>OrtMemoryInfo</code> instance will match one of the values set in the <code>OrtEpDevice</code> using <code>EpDevice_AddAllocatorInfo</code>. Any allocator specific options should be read from the session options.<br/><br/>
135135
Implementation of this function is optional. If not provided, ORT will use `OrtEpFactory::CreateAllocator()`.
@@ -138,7 +138,7 @@ Implementation of this function is optional. If not provided, ORT will use `OrtE
138138
</tr>
139139

140140
<tr>
141-
<td><a href="c-api-ort-ep-create-sync-stream-for-device">CreateSyncStreamForDevice</a></td>
141+
<td>CreateSyncStreamForDevice</td>
142142
<td>
143143
Create a synchronization stream for the given memory device for an <code>OrtSession</code>.<br/><br/>This is used to create a synchronization stream for the execution provider and is used to synchronize operations on the device during model execution. Any stream specific options should be read from the session options.<br/><br/>
144144
Implementation of this function is optional. If not provided, ORT will use `OrtEpFactory::CreateSyncStreamForDevice()`.
@@ -147,7 +147,7 @@ Implementation of this function is optional. If not provided, ORT will use `OrtE
147147
</tr>
148148

149149
<tr>
150-
<td><a href="c-api-ort-ep-get-compiled-model-compatability-info">GetCompiledModelCompatibilityInfo</a></td>
150+
<td>GetCompiledModelCompatibilityInfo</td>
151151
<td>
152152
Get a string with details about the EP stack used to produce a compiled model.<br/><br/>
153153
The compatibility information string can be used with <code>OrtEpFactory::ValidateCompiledModelCompatibilityInfo</code> to determine if a compiled model is compatible with the EP.
@@ -170,43 +170,43 @@ The following table lists the **required** variables and functions that an imple
170170
</tr>
171171

172172
<tr>
173-
<td><a href="#c-api-ort-ep-factory-ort-version-supported">ort_version_supported</a></td>
173+
<td>ort_version_supported</td>
174174
<td>The ONNX Runtime version with which the EP was compiled. Implementation should set this to <code>ORT_API_VERSION</code>.</td>
175175
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L16">ExampleEpFactory()</a></td>
176176
</tr>
177177

178178
<tr>
179-
<td><a href="#c-api-ort-ep-factory-get-name">GetName</a></td>
179+
<td>GetName</td>
180180
<td>Get the name of the EP that the factory creates. Must match <code>OrtEp::GetName()</code>.</td>
181181
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L77">ExampleEpFactory::GetNameImpl()</a></td>
182182
</tr>
183183

184184
<tr>
185-
<td><a href="#c-api-ort-ep-factory-get-vendor">GetVendor</a></td>
185+
<td>GetVendor</td>
186186
<td>Get the name of the name of the vendor that owns the EP that the factory creates.</td>
187187
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L83">ExampleEpFactory::GetVendor()</a></td>
188188
</tr>
189189

190190
<tr>
191-
<td><a href="#c-api-ort-ep-factory-get-vendor-id">GetVendorId</a></td>
191+
<td>GetVendorId</td>
192192
<td>Get the vendor ID of the vendor that owns the EP that the factory creates. This is typically the <a href="https://pcisig.com/membership/member-companies">PCI vendor ID</a>.</td>
193193
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L89">ExampleEpFactory::GetVendorId()</a></td>
194194
</tr>
195195

196196
<tr>
197-
<td><a href="#c-api-ort-ep-factory-get-version">GetVersion</a></td>
197+
<td>GetVersion</td>
198198
<td>Get the version of the EP that the factory creates. The version string should adhere to the <a href="https://github.com/semver/semver/blob/v2.0.0/semver.md">Semantic Versioning 2.0 specification</a>.</td>
199199
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L95">ExampleEpFactory::GetVersionImpl()</a></td>
200200
</tr>
201201

202202
<tr>
203-
<td><a href="#c-api-ort-ep-factory-get-supported-devices">GetSupportedDevices</a></td>
203+
<td>GetSupportedDevices</td>
204204
<td>Get information about the <code>OrtHardwareDevice</code> instances supported by an EP created by the factory.</td>
205205
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L101">ExampleEpFactory::GetSupportedDevicesImpl()</a></td>
206206
</tr>
207207

208208
<tr>
209-
<td><a href="#c-api-ort-ep-factory-create-ep">CreateEp</a></td>
209+
<td>CreateEp</td>
210210
<td>Creates an <code>OrtEp</code> instance for use in an ONNX Runtime session. ORT calls <code>OrtEpFactory::ReleaseEp()</code> to release the instance.</td>
211211
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L163">ExampleEpFactory::CreateEpImpl()</a></td>
212212
</tr>
@@ -223,41 +223,41 @@ The following table lists the **optional** functions that an implementer may def
223223
</tr>
224224

225225
<tr>
226-
<td><a href="#c-api-ort-ep-factory-validate-compiled-model-compatibility-info">ValidateCompiledModelCompatibilityInfo</a></td>
226+
<td>ValidateCompiledModelCompatibilityInfo</td>
227227
<td>Validate the compatibility of a compiled model with the EP.<br/><br/>
228228
This function validates if a model produced with the supllied compatibility information string is supported by the underlying EP.
229229
The implementation should check if a compiled model is compatible with the EP and return the appropriate <code>OrtCompiledModelCompatibility</code> value.</td>
230230
<td></td>
231231
</tr>
232232

233233
<tr>
234-
<td><a href="#c-api-ort-ep-factory-create-allocator">CreateAllocator</a></td>
234+
<td>CreateAllocator</td>
235235
<td>Create an <code>OrtAllocator</code> that can be shared across sessions for the given <code>OrtMemoryInfo</code>.<br/><br/>
236236
The factory that creates the EP is responsible for providing the allocators required by the EP. The <code>OrtMemoryInfo</code> instance will match one of the values set in the <code>OrtEpDevice</code> using <code>EpDevice_AddAllocatorInfo</code>.</td>
237237
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L212">ExampleEpFactory::CreateAllocatorImpl()</a></td>
238238
</tr>
239239

240240
<tr>
241-
<td><a href="#c-api-ort-ep-factory-release-allocator">ReleaseAllocator</a></td>
241+
<td>ReleaseAllocator</td>
242242
<td>Releases an <code>OrtAllocator</code> instance created by the factory.</td>
243243
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L272">ExampleEpFactory::ReleaseAllocatorImpl()</a></td>
244244
</tr>
245245

246246
<tr>
247-
<td><a href="#c-api-ort-ep-factory-create-data-transfer">CreateDataTransfer</a></td>
247+
<td>CreateDataTransfer</td>
248248
<td>Creates an <code>OrtDataTransferImpl</code> instance for the factory.<br/><br/>
249249
An <code>OrtDataTransferImpl</code> can be used to copy data between devices that the EP supports.</td>
250250
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L286">ExampleEpFactory::CreateDataTransferImpl()</a></td>
251251
</tr>
252252

253253
<tr>
254-
<td><a href="#c-api-ort-ep-factory-is-stream-aware">IsStreamAware</a></td>
254+
<td>IsStreamAware</td>
255255
<td>Returns true if the EPs created by the factory are stream-aware.</td>
256256
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L295">ExampleEpFactory::IsStreamAwareImpl()</a></td>
257257
</tr>
258258

259259
<tr>
260-
<td><a href="#c-api-ort-ep-factory-create-sync-stream-for-device">CreateSyncStreamForDevice</a></td>
260+
<td>CreateSyncStreamForDevice</td>
261261
<td>Creates a synchronization stream for the given <code>OrtMemoryDevice</code>.<br/><br/>
262262
This is use to create a synchronization stream for the <code>OrtMemoryDevice</code> that can be used for operations outside of a session.</td>
263263
<td><a href="https://github.com/microsoft/onnxruntime/blob/3cadbdb495761a6a54845b178f9bdb811a2c8bde/onnxruntime/test/autoep/library/ep_factory.cc#L300">ExampleEpFactory::CreateSyncStreamForDeviceImpl()</a></td>
@@ -457,7 +457,7 @@ API header files:
457457
458458
<tr>
459459
<td>
460-
<a href="#ort-hardware-device-type">OrtHardwareDeviceType</a>
460+
OrtHardwareDeviceType
461461
</td>
462462
<td>
463463
Enumerates classes of hardware devices:<br>
@@ -552,7 +552,7 @@ Opaque type that represents a combination of a physical device and memory type.
552552
553553
<tr>
554554
<td>
555-
<a href="#ort-data-transfer-impl">OrtDataTransferImpl</a>
555+
OrtDataTransferImpl
556556
</td>
557557
<td>
558558
Struct of functions that an EP implements to copy data between the devices that the EP uses and CPU.
@@ -561,7 +561,7 @@ Struct of functions that an EP implements to copy data between the devices that
561561
562562
<tr>
563563
<td>
564-
<a href="#ort-sync-notification-impl">OrtSyncNotificationImpl</a>
564+
OrtSyncNotificationImpl
565565
</td>
566566
<td>
567567
Struct of functions that an EP implements for Stream notifications.
@@ -570,7 +570,7 @@ Struct of functions that an EP implements for Stream notifications.
570570
571571
<tr>
572572
<td>
573-
<a href="#ort-sync-stream-impl">OrtSyncStreamImpl</a>
573+
OrtSyncStreamImpl
574574
</td>
575575
<td>
576576
Struct of functions that an EP implements if it needs to support Streams.
@@ -579,7 +579,7 @@ Struct of functions that an EP implements if it needs to support Streams.
579579
580580
<tr>
581581
<td>
582-
<a href="#ort-ep-factory">OrtEpFactory</a>
582+
OrtEpFactory
583583
</td>
584584
<td>
585585
A plugin EP library provides ORT with one or more instances of <code>OrtEpFactory</code>. An <code>OrtEpFactory</code> implements functions that are used by ORT to query device support, create allocators, create data transfer objects, and create instances of an EP (i.e., an <code>OrtEp</code> instance).<br/>
@@ -592,7 +592,7 @@ Alternatively, if an EP library author needs ONNX Runtime to partition the graph
592592
593593
<tr>
594594
<td>
595-
<a href="#ort-ep">OrtEp</a>
595+
OrtEp
596596
</td>
597597
<td>
598598
An instance of an Ep that can execute model nodes on one or more hardware devices (<code>OrtHardwareDevice</code>). An <code>OrtEp</code> implements functions that are used by ORT to query graph node support, compile supported nodes, query preferred data layout, set run options, etc. An <code>OrtEpFactory</code> creates an <code>OrtEp</code> instance via the <code>OrtEpFactory::CreateEp()</code> function.
@@ -670,7 +670,7 @@ Opaque type that represents a node in a graph.
670670
671671
<tr>
672672
<td>
673-
<a href="#ort-op-attr-type">OrtOpAttrType</a>
673+
OrtOpAttrType
674674
</td>
675675
<td>
676676
Enumerates attribute types.

docs/genai/tutorials/finetune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,5 +161,5 @@ python app.py -m <model folder> -a <.onnx_adapter files> -t <prompt template> -s
161161

162162
## References
163163

164-
* [Python API docs](../api/python.md#adapter-class)
164+
* [Python API docs](../api/python.md)
165165
* [Olive CLI docs](https://microsoft.github.io/Olive/how-to/index.html#working-with-the-cli)

0 commit comments

Comments
 (0)