Skip to content

Commit 70e3813

Browse files
Docs redesigning inference section 25.1 (#29566)
port: #29298 #29565 --------- Signed-off-by: sgolebiewski-intel <sebastianx.golebiewski@intel.com> Co-authored-by: sgolebiewski-intel <sebastianx.golebiewski@intel.com>
1 parent 5933ccf commit 70e3813

File tree

68 files changed

+1289
-1244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1289
-1244
lines changed

docs/articles_en/about-openvino/performance-benchmarks/getting-performance-numbers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ General considerations
132132
* Do not include model loading time.
133133
* Ensure that the inputs are identical for OpenVINO Runtime and the framework. For example, watch out for random values that can be used to populate the inputs.
134134
* In situations when any user-side pre-processing should be tracked separately, consider :doc:`image pre-processing and conversion <../../openvino-workflow/running-inference/optimize-inference/optimize-preprocessing>`.
135-
* When applicable, leverage the :doc:`Dynamic Shapes support <../../openvino-workflow/running-inference/dynamic-shapes>`.
135+
* When applicable, leverage the :doc:`Dynamic Shapes support <../../openvino-workflow/running-inference/model-input-output/dynamic-shapes>`.
136136
* If possible, demand the same accuracy. For example, TensorFlow allows ``FP16`` execution, so when comparing to that, make sure to test the OpenVINO Runtime with the ``FP16`` as well.
137137

138138
.. dropdown:: Make sure the benchmarking setup is proper for the selected scenario
@@ -244,7 +244,7 @@ request, while the actual latency can be quite different.
244244

245245
Lastly, the performance statistics with both performance counters and execution graphs are
246246
averaged, so such data for the
247-
:doc:`inputs of dynamic shapes <../../openvino-workflow/running-inference/dynamic-shapes>`
247+
:doc:`inputs of dynamic shapes <../../openvino-workflow/running-inference/model-input-output/dynamic-shapes>`
248248
should be measured carefully, preferably by isolating the specific shape and executing multiple
249249
times in a loop, to gather reliable data.
250250

docs/articles_en/documentation/compatibility-and-support/supported-devices.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ Feature Support and API Coverage
4242
:doc:`Automatic batching <../../openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching>` No Yes No
4343
:doc:`Multi-stream execution <../../openvino-workflow/running-inference/optimize-inference/optimizing-throughput>` Yes Yes No
4444
:doc:`Model caching <../../openvino-workflow/running-inference/optimize-inference/optimizing-latency/model-caching-overview>` Yes Partial Yes
45-
:doc:`Dynamic shapes <../../openvino-workflow/running-inference/dynamic-shapes>` Yes Partial No
45+
:doc:`Dynamic shapes <../../openvino-workflow/running-inference/model-input-output/dynamic-shapes>` Yes Partial No
4646
:doc:`Preprocessing acceleration <../../openvino-workflow/running-inference/optimize-inference/optimize-preprocessing>` Yes Yes No
47-
:doc:`Stateful models <../../openvino-workflow/running-inference/stateful-models>` Yes Yes Yes
47+
:doc:`Stateful models <../../openvino-workflow/running-inference/inference-request/stateful-models>` Yes Yes Yes
4848
:doc:`Extensibility <../../documentation/openvino-extensibility>` Yes Yes No
4949
======================================================================================================================================== ======= ========== ===========
5050

@@ -73,7 +73,7 @@ Feature Support and API Coverage
7373
+-------------------------+-----------+------------------+-------------------+
7474

7575
For setting up a relevant configuration, refer to the
76-
:doc:`Integrate with Customer Application <../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
76+
:doc:`Integrate with Customer Application <../../openvino-workflow/running-inference>`
7777
topic (step 3 "Configure input and output").
7878

7979
.. dropdown:: Device support across OpenVINO 2024.6 distributions

docs/articles_en/documentation/openvino-extensibility/transformation-api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Working with Model
2525
##################
2626

2727
Before moving to the transformation part, it is important to say a few words about the functions which allow modifying ``ov::Model``.
28-
This section extends the :doc:`model representation guide <../../openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation>`
28+
This section extends the :doc:`model representation guide <../../openvino-workflow/running-inference/model-representation>`
2929
and introduces an API for ``ov::Model`` manipulation.
3030

3131
Working with node input and output ports
@@ -244,6 +244,6 @@ additional debug capabilities by using the following environment variables:
244244
See Also
245245
########
246246

247-
* :doc:`OpenVINO™ Model Representation <../../openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation>`
247+
* :doc:`OpenVINO™ Model Representation <../../openvino-workflow/running-inference/model-representation>`
248248
* :doc:`OpenVINO™ Extensions <../openvino-extensibility>`
249249

docs/articles_en/documentation/openvino-ir-format/operation-sets/operation-specs/infrastructure/assign-6.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Assign
1616

1717
ReadValue, Assign, and Variable define a coherent mechanism for reading, writing and
1818
storing a memory buffer between inference calls. More details can be found on the
19-
:doc:`State API <../../../../../../openvino-workflow/running-inference/stateful-models>` documentation page.
19+
:doc:`State API <../../../../../../openvino-workflow/running-inference/inference-request/stateful-models>` documentation page.
2020

2121
*Assign* sets an input value to the ``variable_id`` variable. This value will be read
2222
by the *ReadValue* operation on the next inference call if it has not been reset.

docs/articles_en/documentation/openvino-ir-format/operation-sets/operation-specs/infrastructure/read-value-6.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ReadValue
1717

1818
*ReadValue*, *Assign*, and *Variable* define a coherent mechanism for reading, writing,
1919
and storing some memory buffer between inference calls. More details can be found on the
20-
:doc:`StateAPI <../../../../../../openvino-workflow/running-inference/stateful-models>` documentation page.
20+
:doc:`StateAPI <../../../../../../openvino-workflow/running-inference/inference-request/stateful-models>` documentation page.
2121

2222
If the 1st input is provided and this is the first inference or reset has been called,
2323
*ReadValue* returns the value from the 1st input.

docs/articles_en/documentation/openvino-ir-format/operation-sets/operation-specs/movement/unique-10.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The operator can either work in elementwise mode searching for unique values in
5252

5353
**Outputs**
5454

55-
* **1**: The output tensor containing unique elements (individual values or subtensors). This tensor's type matches the type of the first input tensor: *T*. The values in this tensor are either sorted ascendingly or maintain the same order as in the input tensor. The shape of this output depends on the values of the input tensor and will very often be dynamic. Please refer to the article describing how :doc:`Dynamic Shapes <../../../../../openvino-workflow/running-inference/dynamic-shapes>` are handled in OpenVINO.
55+
* **1**: The output tensor containing unique elements (individual values or subtensors). This tensor's type matches the type of the first input tensor: *T*. The values in this tensor are either sorted ascendingly or maintain the same order as in the input tensor. The shape of this output depends on the values of the input tensor and will very often be dynamic. Please refer to the article describing how :doc:`Dynamic Shapes <../../../../../openvino-workflow/running-inference/model-input-output/dynamic-shapes>` are handled in OpenVINO.
5656
* **2**: The output tensor containing indices of the locations of unique elements. The indices map the elements in the first output tensor to their locations in the input tensor. The index always points to the first occurrence of a given unique output element in the input tensor. This is a 1D tensor with type controlled by the ``index_element_type`` attribute.
5757
* **3**: The output tensor containing indices of the locations of elements of the input tensor in the first output tensor. This means that for each element of the input tensor this output will point to the unique value in the first output tensor of this operator. This is a 1D tensor with type controlled by the ``index_element_type`` attribute.
5858
* **4**: The output tensor containing the number of occurrences of each unique value produced by this operator in the first output tensor. This is a 1D tensor with type controlled by the ``count_element_type`` attribute.

docs/articles_en/get-started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ View :doc:`sample code <get-started/learn-openvino/openvino-samples>` for variou
9090
Integrate OpenVINO With Your Application
9191
----------------------------------------
9292

93-
Learn how to :doc:`use the OpenVINO API to implement an inference pipeline <openvino-workflow/running-inference/integrate-openvino-with-your-application>` in your application.
93+
Learn how to :doc:`use the OpenVINO API to implement an inference pipeline <openvino-workflow/running-inference>` in your application.
9494

9595
.. _openvino-advanced-features:
9696

@@ -123,7 +123,7 @@ Pipeline and model configuration features in OpenVINO Runtime allow you to easil
123123

124124
* :doc:`Automatic Batching <openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching>` performs on-the-fly grouping of inference requests to maximize utilization of the target hardware’s memory and processing cores.
125125
* :doc:`Performance Hints <openvino-workflow/running-inference/optimize-inference/high-level-performance-hints>` automatically adjust runtime parameters to prioritize for low latency or high throughput
126-
* :doc:`Dynamic Shapes <openvino-workflow/running-inference/dynamic-shapes>` reshapes models to accept arbitrarily-sized inputs, increasing flexibility for applications that encounter different data shapes
126+
* :doc:`Dynamic Shapes <openvino-workflow/running-inference/model-input-output/dynamic-shapes>` reshapes models to accept arbitrarily-sized inputs, increasing flexibility for applications that encounter different data shapes
127127
* :doc:`Benchmark Tool <get-started/learn-openvino/openvino-samples/benchmark-tool>` characterizes model performance in various hardware and pipeline configurations
128128

129129
.. _additional-about-openvino/additional-resources:

docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,6 @@ Additional Resources
188188

189189
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../install-openvino>`
190190
* :doc:`Convert models for use with OpenVINO™ <../../../openvino-workflow/model-preparation/convert-model-to-ir>`
191-
* :doc:`Write your own OpenVINO™ applications <../../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
191+
* :doc:`Write your own OpenVINO™ applications <../../../openvino-workflow/running-inference>`
192192
* Sample applications: :doc:`OpenVINO™ Toolkit Samples Overview <../../../get-started/learn-openvino/openvino-samples>`
193193
* Pre-trained deep learning models on `Hugging Face <https://huggingface.co/OpenVINO>`__

docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,6 @@ Additional Resources
211211

212212
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../install-openvino>`
213213
* :doc:`Convert models for use with OpenVINO™ <../../../openvino-workflow/model-preparation/convert-model-to-ir>`
214-
* :doc:`Write your own OpenVINO™ applications <../../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
214+
* :doc:`Write your own OpenVINO™ applications <../../../openvino-workflow/running-inference>`
215215
* Sample applications: :doc:`OpenVINO™ Toolkit Samples Overview <../../../get-started/learn-openvino/openvino-samples>`
216216
* Pre-trained deep learning models on `Hugging Face <https://huggingface.co/OpenVINO>`__.

docs/articles_en/get-started/learn-openvino/openvino-samples/bert-benchmark.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ resulting model, downloads a dataset and runs a benchmark on the dataset.
2626

2727

2828
You can see the explicit description of each sample step at
29-
:doc:`Integration Steps <../../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
29+
:doc:`Integration Steps <../../../openvino-workflow/running-inference>`
3030
section of "Integrate OpenVINO™ Runtime with Your Application" guide.
3131

3232
Running
@@ -60,7 +60,7 @@ The sample outputs how long it takes to process a dataset.
6060
Additional Resources
6161
####################
6262

63-
- :doc:`Integrate the OpenVINO™ Runtime with Your Application <../../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
63+
- :doc:`Integrate the OpenVINO™ Runtime with Your Application <../../../openvino-workflow/running-inference>`
6464
- :doc:`Get Started with Samples <get-started-demos>`
6565
- :doc:`Using OpenVINO Samples <../openvino-samples>`
6666
- :doc:`Convert a Model <../../../openvino-workflow/model-preparation/convert-model-to-ir>`

0 commit comments

Comments
 (0)