diff --git a/docs/snippets/AUTO0.cpp b/docs/articles_en/assets/snippets/AUTO0.cpp similarity index 100% rename from docs/snippets/AUTO0.cpp rename to docs/articles_en/assets/snippets/AUTO0.cpp diff --git a/docs/snippets/AUTO3.cpp b/docs/articles_en/assets/snippets/AUTO3.cpp similarity index 100% rename from docs/snippets/AUTO3.cpp rename to docs/articles_en/assets/snippets/AUTO3.cpp diff --git a/docs/snippets/AUTO4.cpp b/docs/articles_en/assets/snippets/AUTO4.cpp similarity index 100% rename from docs/snippets/AUTO4.cpp rename to docs/articles_en/assets/snippets/AUTO4.cpp diff --git a/docs/snippets/AUTO5.cpp b/docs/articles_en/assets/snippets/AUTO5.cpp similarity index 100% rename from docs/snippets/AUTO5.cpp rename to docs/articles_en/assets/snippets/AUTO5.cpp diff --git a/docs/snippets/AUTO6.cpp b/docs/articles_en/assets/snippets/AUTO6.cpp similarity index 100% rename from docs/snippets/AUTO6.cpp rename to docs/articles_en/assets/snippets/AUTO6.cpp diff --git a/docs/snippets/AUTO7.cpp b/docs/articles_en/assets/snippets/AUTO7.cpp similarity index 100% rename from docs/snippets/AUTO7.cpp rename to docs/articles_en/assets/snippets/AUTO7.cpp diff --git a/docs/snippets/cpu/Bfloat16Inference.py b/docs/articles_en/assets/snippets/Bfloat16Inference.py similarity index 100% rename from docs/snippets/cpu/Bfloat16Inference.py rename to docs/articles_en/assets/snippets/Bfloat16Inference.py diff --git a/docs/snippets/cpu/Bfloat16Inference0.cpp b/docs/articles_en/assets/snippets/Bfloat16Inference0.cpp similarity index 100% rename from docs/snippets/cpu/Bfloat16Inference0.cpp rename to docs/articles_en/assets/snippets/Bfloat16Inference0.cpp diff --git a/docs/snippets/cpu/Bfloat16Inference1.cpp b/docs/articles_en/assets/snippets/Bfloat16Inference1.cpp similarity index 100% rename from docs/snippets/cpu/Bfloat16Inference1.cpp rename to docs/articles_en/assets/snippets/Bfloat16Inference1.cpp diff --git a/docs/snippets/cpu/Bfloat16Inference2.cpp b/docs/articles_en/assets/snippets/Bfloat16Inference2.cpp similarity index 100% rename from docs/snippets/cpu/Bfloat16Inference2.cpp rename to docs/articles_en/assets/snippets/Bfloat16Inference2.cpp diff --git a/docs/snippets/MULTI0.cpp b/docs/articles_en/assets/snippets/MULTI0.cpp similarity index 100% rename from docs/snippets/MULTI0.cpp rename to docs/articles_en/assets/snippets/MULTI0.cpp diff --git a/docs/snippets/MULTI2.cpp b/docs/articles_en/assets/snippets/MULTI2.cpp similarity index 100% rename from docs/snippets/MULTI2.cpp rename to docs/articles_en/assets/snippets/MULTI2.cpp diff --git a/docs/snippets/MULTI3.cpp b/docs/articles_en/assets/snippets/MULTI3.cpp similarity index 100% rename from docs/snippets/MULTI3.cpp rename to docs/articles_en/assets/snippets/MULTI3.cpp diff --git a/docs/snippets/MULTI4.cpp b/docs/articles_en/assets/snippets/MULTI4.cpp similarity index 100% rename from docs/snippets/MULTI4.cpp rename to docs/articles_en/assets/snippets/MULTI4.cpp diff --git a/docs/snippets/MULTI5.cpp b/docs/articles_en/assets/snippets/MULTI5.cpp similarity index 100% rename from docs/snippets/MULTI5.cpp rename to docs/articles_en/assets/snippets/MULTI5.cpp diff --git a/docs/snippets/ShapeInference.cpp b/docs/articles_en/assets/snippets/ShapeInference.cpp similarity index 100% rename from docs/snippets/ShapeInference.cpp rename to docs/articles_en/assets/snippets/ShapeInference.cpp diff --git a/docs/snippets/ShapeInference.py b/docs/articles_en/assets/snippets/ShapeInference.py similarity index 100% rename from docs/snippets/ShapeInference.py rename to docs/articles_en/assets/snippets/ShapeInference.py diff --git a/docs/snippets/cpu/compile_model.cpp b/docs/articles_en/assets/snippets/compile_model_cpu.cpp similarity index 100% rename from docs/snippets/cpu/compile_model.cpp rename to docs/articles_en/assets/snippets/compile_model_cpu.cpp diff --git a/docs/snippets/cpu/compile_model.py b/docs/articles_en/assets/snippets/compile_model_cpu.py similarity index 100% rename from docs/snippets/cpu/compile_model.py rename to docs/articles_en/assets/snippets/compile_model_cpu.py diff --git a/docs/snippets/gpu/compile_model.cpp b/docs/articles_en/assets/snippets/compile_model_gpu.cpp similarity index 100% rename from docs/snippets/gpu/compile_model.cpp rename to docs/articles_en/assets/snippets/compile_model_gpu.cpp diff --git a/docs/snippets/gpu/compile_model.py b/docs/articles_en/assets/snippets/compile_model_gpu.py similarity index 100% rename from docs/snippets/gpu/compile_model.py rename to docs/articles_en/assets/snippets/compile_model_gpu.py diff --git a/docs/snippets/gpu/context_sharing.cpp b/docs/articles_en/assets/snippets/context_sharing.cpp similarity index 100% rename from docs/snippets/gpu/context_sharing.cpp rename to docs/articles_en/assets/snippets/context_sharing.cpp diff --git a/docs/snippets/gpu/context_sharing_va.cpp b/docs/articles_en/assets/snippets/context_sharing_va.cpp similarity index 100% rename from docs/snippets/gpu/context_sharing_va.cpp rename to docs/articles_en/assets/snippets/context_sharing_va.cpp diff --git a/docs/snippets/gpu/context_sharing_va_c.cpp b/docs/articles_en/assets/snippets/context_sharing_va_c.cpp similarity index 100% rename from docs/snippets/gpu/context_sharing_va_c.cpp rename to docs/articles_en/assets/snippets/context_sharing_va_c.cpp diff --git a/docs/snippets/gpu/custom_kernels_api.cpp b/docs/articles_en/assets/snippets/custom_kernels_api.cpp similarity index 100% rename from docs/snippets/gpu/custom_kernels_api.cpp rename to docs/articles_en/assets/snippets/custom_kernels_api.cpp diff --git a/docs/snippets/gpu/custom_kernels_api.py b/docs/articles_en/assets/snippets/custom_kernels_api.py similarity index 100% rename from docs/snippets/gpu/custom_kernels_api.py rename to docs/articles_en/assets/snippets/custom_kernels_api.py diff --git a/docs/snippets/dldt_optimization_guide8.cpp b/docs/articles_en/assets/snippets/dldt_optimization_guide8.cpp similarity index 100% rename from docs/snippets/dldt_optimization_guide8.cpp rename to docs/articles_en/assets/snippets/dldt_optimization_guide8.cpp diff --git a/docs/snippets/dldt_optimization_guide9.cpp b/docs/articles_en/assets/snippets/dldt_optimization_guide9.cpp similarity index 100% rename from docs/snippets/dldt_optimization_guide9.cpp rename to docs/articles_en/assets/snippets/dldt_optimization_guide9.cpp diff --git a/docs/snippets/gpu/dynamic_batch.cpp b/docs/articles_en/assets/snippets/dynamic_batch.cpp similarity index 100% rename from docs/snippets/gpu/dynamic_batch.cpp rename to docs/articles_en/assets/snippets/dynamic_batch.cpp diff --git a/docs/snippets/gpu/dynamic_batch.py b/docs/articles_en/assets/snippets/dynamic_batch.py similarity index 100% rename from docs/snippets/gpu/dynamic_batch.py rename to docs/articles_en/assets/snippets/dynamic_batch.py diff --git a/docs/snippets/cpu/dynamic_shape.cpp b/docs/articles_en/assets/snippets/dynamic_shape.cpp similarity index 100% rename from docs/snippets/cpu/dynamic_shape.cpp rename to docs/articles_en/assets/snippets/dynamic_shape.cpp diff --git a/docs/snippets/cpu/dynamic_shape.py b/docs/articles_en/assets/snippets/dynamic_shape.py similarity index 100% rename from docs/snippets/cpu/dynamic_shape.py rename to docs/articles_en/assets/snippets/dynamic_shape.py diff --git a/docs/snippets/export_compiled_model.cpp b/docs/articles_en/assets/snippets/export_compiled_model.cpp similarity index 100% rename from docs/snippets/export_compiled_model.cpp rename to docs/articles_en/assets/snippets/export_compiled_model.cpp diff --git a/docs/snippets/export_compiled_model.py b/docs/articles_en/assets/snippets/export_compiled_model.py similarity index 100% rename from docs/snippets/export_compiled_model.py rename to docs/articles_en/assets/snippets/export_compiled_model.py diff --git a/docs/snippets/lpt_intel_cpu_plugin.cpp b/docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp similarity index 100% rename from docs/snippets/lpt_intel_cpu_plugin.cpp rename to docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp diff --git a/docs/snippets/cpu/multi_threading.cpp b/docs/articles_en/assets/snippets/multi_threading.cpp similarity index 100% rename from docs/snippets/cpu/multi_threading.cpp rename to docs/articles_en/assets/snippets/multi_threading.cpp diff --git a/docs/snippets/cpu/multi_threading.py b/docs/articles_en/assets/snippets/multi_threading.py similarity index 100% rename from docs/snippets/cpu/multi_threading.py rename to docs/articles_en/assets/snippets/multi_threading.py diff --git a/docs/snippets/ov_auto.py b/docs/articles_en/assets/snippets/ov_auto.py similarity index 100% rename from docs/snippets/ov_auto.py rename to docs/articles_en/assets/snippets/ov_auto.py diff --git a/docs/snippets/ov_auto_batching.cpp b/docs/articles_en/assets/snippets/ov_auto_batching.cpp similarity index 100% rename from docs/snippets/ov_auto_batching.cpp rename to docs/articles_en/assets/snippets/ov_auto_batching.cpp diff --git a/docs/snippets/ov_auto_batching.py b/docs/articles_en/assets/snippets/ov_auto_batching.py similarity index 100% rename from docs/snippets/ov_auto_batching.py rename to docs/articles_en/assets/snippets/ov_auto_batching.py diff --git a/docs/snippets/ov_caching.cpp b/docs/articles_en/assets/snippets/ov_caching.cpp similarity index 100% rename from docs/snippets/ov_caching.cpp rename to docs/articles_en/assets/snippets/ov_caching.cpp diff --git a/docs/snippets/ov_caching.py b/docs/articles_en/assets/snippets/ov_caching.py similarity index 100% rename from docs/snippets/ov_caching.py rename to docs/articles_en/assets/snippets/ov_caching.py diff --git a/docs/snippets/ov_denormals.cpp b/docs/articles_en/assets/snippets/ov_denormals.cpp similarity index 100% rename from docs/snippets/ov_denormals.cpp rename to docs/articles_en/assets/snippets/ov_denormals.cpp diff --git a/docs/snippets/ov_denormals.py b/docs/articles_en/assets/snippets/ov_denormals.py similarity index 100% rename from docs/snippets/ov_denormals.py rename to docs/articles_en/assets/snippets/ov_denormals.py diff --git a/docs/snippets/ov_dynamic_shapes.c b/docs/articles_en/assets/snippets/ov_dynamic_shapes.c similarity index 100% rename from docs/snippets/ov_dynamic_shapes.c rename to docs/articles_en/assets/snippets/ov_dynamic_shapes.c diff --git a/docs/snippets/ov_dynamic_shapes.cpp b/docs/articles_en/assets/snippets/ov_dynamic_shapes.cpp similarity index 100% rename from docs/snippets/ov_dynamic_shapes.cpp rename to docs/articles_en/assets/snippets/ov_dynamic_shapes.cpp diff --git a/docs/snippets/ov_dynamic_shapes.py b/docs/articles_en/assets/snippets/ov_dynamic_shapes.py similarity index 100% rename from docs/snippets/ov_dynamic_shapes.py rename to docs/articles_en/assets/snippets/ov_dynamic_shapes.py diff --git a/docs/snippets/cpu/ov_execution_mode.cpp b/docs/articles_en/assets/snippets/ov_execution_mode.cpp similarity index 100% rename from docs/snippets/cpu/ov_execution_mode.cpp rename to docs/articles_en/assets/snippets/ov_execution_mode.cpp diff --git a/docs/snippets/cpu/ov_execution_mode.py b/docs/articles_en/assets/snippets/ov_execution_mode.py similarity index 100% rename from docs/snippets/cpu/ov_execution_mode.py rename to docs/articles_en/assets/snippets/ov_execution_mode.py diff --git a/docs/snippets/ov_extensions.cpp b/docs/articles_en/assets/snippets/ov_extensions.cpp similarity index 100% rename from docs/snippets/ov_extensions.cpp rename to docs/articles_en/assets/snippets/ov_extensions.cpp diff --git a/docs/snippets/ov_extensions.py b/docs/articles_en/assets/snippets/ov_extensions.py similarity index 100% rename from docs/snippets/ov_extensions.py rename to docs/articles_en/assets/snippets/ov_extensions.py diff --git a/docs/snippets/ov_hetero.cpp b/docs/articles_en/assets/snippets/ov_hetero.cpp similarity index 100% rename from docs/snippets/ov_hetero.cpp rename to docs/articles_en/assets/snippets/ov_hetero.cpp diff --git a/docs/snippets/ov_hetero.py b/docs/articles_en/assets/snippets/ov_hetero.py similarity index 100% rename from docs/snippets/ov_hetero.py rename to docs/articles_en/assets/snippets/ov_hetero.py diff --git a/docs/snippets/ov_infer_request.cpp b/docs/articles_en/assets/snippets/ov_infer_request.cpp similarity index 100% rename from docs/snippets/ov_infer_request.cpp rename to docs/articles_en/assets/snippets/ov_infer_request.cpp diff --git a/docs/snippets/ov_infer_request.py b/docs/articles_en/assets/snippets/ov_infer_request.py similarity index 100% rename from docs/snippets/ov_infer_request.py rename to docs/articles_en/assets/snippets/ov_infer_request.py diff --git a/docs/snippets/ov_layout.cpp b/docs/articles_en/assets/snippets/ov_layout.cpp similarity index 100% rename from docs/snippets/ov_layout.cpp rename to docs/articles_en/assets/snippets/ov_layout.cpp diff --git a/docs/snippets/ov_layout.py b/docs/articles_en/assets/snippets/ov_layout.py similarity index 100% rename from docs/snippets/ov_layout.py rename to docs/articles_en/assets/snippets/ov_layout.py diff --git a/docs/snippets/ov_model_snippets.cpp b/docs/articles_en/assets/snippets/ov_model_snippets.cpp similarity index 100% rename from docs/snippets/ov_model_snippets.cpp rename to docs/articles_en/assets/snippets/ov_model_snippets.cpp diff --git a/docs/snippets/ov_model_snippets.py b/docs/articles_en/assets/snippets/ov_model_snippets.py similarity index 100% rename from docs/snippets/ov_model_snippets.py rename to docs/articles_en/assets/snippets/ov_model_snippets.py diff --git a/docs/snippets/ov_multi.py b/docs/articles_en/assets/snippets/ov_multi.py similarity index 100% rename from docs/snippets/ov_multi.py rename to docs/articles_en/assets/snippets/ov_multi.py diff --git a/docs/snippets/ov_preprocessing.cpp b/docs/articles_en/assets/snippets/ov_preprocessing.cpp similarity index 100% rename from docs/snippets/ov_preprocessing.cpp rename to docs/articles_en/assets/snippets/ov_preprocessing.cpp diff --git a/docs/snippets/ov_preprocessing.py b/docs/articles_en/assets/snippets/ov_preprocessing.py similarity index 100% rename from docs/snippets/ov_preprocessing.py rename to docs/articles_en/assets/snippets/ov_preprocessing.py diff --git a/docs/snippets/ov_properties_api.cpp b/docs/articles_en/assets/snippets/ov_properties_api.cpp similarity index 100% rename from docs/snippets/ov_properties_api.cpp rename to docs/articles_en/assets/snippets/ov_properties_api.cpp diff --git a/docs/snippets/ov_properties_api.py b/docs/articles_en/assets/snippets/ov_properties_api.py similarity index 100% rename from docs/snippets/ov_properties_api.py rename to docs/articles_en/assets/snippets/ov_properties_api.py diff --git a/docs/snippets/ov_python_exclusives.py b/docs/articles_en/assets/snippets/ov_python_exclusives.py similarity index 100% rename from docs/snippets/ov_python_exclusives.py rename to docs/articles_en/assets/snippets/ov_python_exclusives.py diff --git a/docs/snippets/ov_python_inference.py b/docs/articles_en/assets/snippets/ov_python_inference.py similarity index 100% rename from docs/snippets/ov_python_inference.py rename to docs/articles_en/assets/snippets/ov_python_inference.py diff --git a/docs/snippets/cpu/ov_sparse_weights_decompression.cpp b/docs/articles_en/assets/snippets/ov_sparse_weights_decompression.cpp similarity index 100% rename from docs/snippets/cpu/ov_sparse_weights_decompression.cpp rename to docs/articles_en/assets/snippets/ov_sparse_weights_decompression.cpp diff --git a/docs/snippets/cpu/ov_sparse_weights_decompression.py b/docs/articles_en/assets/snippets/ov_sparse_weights_decompression.py similarity index 100% rename from docs/snippets/cpu/ov_sparse_weights_decompression.py rename to docs/articles_en/assets/snippets/ov_sparse_weights_decompression.py diff --git a/docs/snippets/ov_stateful_models_intro.cpp b/docs/articles_en/assets/snippets/ov_stateful_models_intro.cpp similarity index 100% rename from docs/snippets/ov_stateful_models_intro.cpp rename to docs/articles_en/assets/snippets/ov_stateful_models_intro.cpp diff --git a/docs/snippets/gpu/preprocessing_nv12_single_plane.cpp b/docs/articles_en/assets/snippets/preprocessing_nv12_single_plane.cpp similarity index 100% rename from docs/snippets/gpu/preprocessing_nv12_single_plane.cpp rename to docs/articles_en/assets/snippets/preprocessing_nv12_single_plane.cpp diff --git a/docs/snippets/gpu/preprocessing_nv12_to_gray.cpp b/docs/articles_en/assets/snippets/preprocessing_nv12_to_gray.cpp similarity index 100% rename from docs/snippets/gpu/preprocessing_nv12_to_gray.cpp rename to docs/articles_en/assets/snippets/preprocessing_nv12_to_gray.cpp diff --git a/docs/snippets/gpu/preprocessing_nv12_two_planes.cpp b/docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp similarity index 100% rename from docs/snippets/gpu/preprocessing_nv12_two_planes.cpp rename to docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp diff --git a/docs/snippets/gpu/preprocessing_nv12_two_planes.py b/docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.py similarity index 100% rename from docs/snippets/gpu/preprocessing_nv12_two_planes.py rename to docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.py diff --git a/docs/snippets/gpu/preprocessing_nv12_two_planes_c.cpp b/docs/articles_en/assets/snippets/preprocessing_nv12_two_planes_c.cpp similarity index 100% rename from docs/snippets/gpu/preprocessing_nv12_two_planes_c.cpp rename to docs/articles_en/assets/snippets/preprocessing_nv12_two_planes_c.cpp diff --git a/docs/snippets/protecting_model_guide.cpp b/docs/articles_en/assets/snippets/protecting_model_guide.cpp similarity index 100% rename from docs/snippets/protecting_model_guide.cpp rename to docs/articles_en/assets/snippets/protecting_model_guide.cpp diff --git a/docs/snippets/gpu/queue_sharing.cpp b/docs/articles_en/assets/snippets/queue_sharing.cpp similarity index 100% rename from docs/snippets/gpu/queue_sharing.cpp rename to docs/articles_en/assets/snippets/queue_sharing.cpp diff --git a/docs/snippets/gpu/remote_objects_creation.cpp b/docs/articles_en/assets/snippets/remote_objects_creation.cpp similarity index 100% rename from docs/snippets/gpu/remote_objects_creation.cpp rename to docs/articles_en/assets/snippets/remote_objects_creation.cpp diff --git a/docs/snippets/gpu/remote_objects_creation_c.cpp b/docs/articles_en/assets/snippets/remote_objects_creation_c.cpp similarity index 100% rename from docs/snippets/gpu/remote_objects_creation_c.cpp rename to docs/articles_en/assets/snippets/remote_objects_creation_c.cpp diff --git a/docs/snippets/template_model_transformation.cpp b/docs/articles_en/assets/snippets/template_model_transformation.cpp similarity index 100% rename from docs/snippets/template_model_transformation.cpp rename to docs/articles_en/assets/snippets/template_model_transformation.cpp diff --git a/docs/snippets/template_model_transformation.hpp b/docs/articles_en/assets/snippets/template_model_transformation.hpp similarity index 100% rename from docs/snippets/template_model_transformation.hpp rename to docs/articles_en/assets/snippets/template_model_transformation.hpp diff --git a/docs/snippets/template_pattern_transformation.cpp b/docs/articles_en/assets/snippets/template_pattern_transformation.cpp similarity index 100% rename from docs/snippets/template_pattern_transformation.cpp rename to docs/articles_en/assets/snippets/template_pattern_transformation.cpp diff --git a/docs/snippets/template_pattern_transformation.hpp b/docs/articles_en/assets/snippets/template_pattern_transformation.hpp similarity index 100% rename from docs/snippets/template_pattern_transformation.hpp rename to docs/articles_en/assets/snippets/template_pattern_transformation.hpp diff --git a/docs/snippets/torchvision_preprocessing.py b/docs/articles_en/assets/snippets/torchvision_preprocessing.py similarity index 100% rename from docs/snippets/torchvision_preprocessing.py rename to docs/articles_en/assets/snippets/torchvision_preprocessing.py diff --git a/docs/articles_en/documentation/legacy-features.rst b/docs/articles_en/documentation/legacy-features.rst index dec5a70cd2b..dd5938398be 100644 --- a/docs/articles_en/documentation/legacy-features.rst +++ b/docs/articles_en/documentation/legacy-features.rst @@ -96,14 +96,14 @@ Discontinued: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/export_compiled_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/export_compiled_model.py :language: python :fragment: [export_compiled_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/export_compiled_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/export_compiled_model.cpp :language: cpp :fragment: [export_compiled_model] diff --git a/docs/articles_en/documentation/openvino-extensibility.rst b/docs/articles_en/documentation/openvino-extensibility.rst index 61eed8b48cf..13fa2c36a4b 100644 --- a/docs/articles_en/documentation/openvino-extensibility.rst +++ b/docs/articles_en/documentation/openvino-extensibility.rst @@ -94,14 +94,14 @@ Extensions can be loaded from a code with the ``ov::Core::add_extension`` metho .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [add_extension] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [add_extension] @@ -113,14 +113,14 @@ The ``Identity`` is a custom operation class defined in :doc:`Custom Operation G .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [add_frontend_extension] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [add_frontend_extension] @@ -176,14 +176,14 @@ This CMake script finds OpenVINO, using the ``find_package`` CMake command. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [add_extension_lib] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [add_extension_lib] diff --git a/docs/articles_en/documentation/openvino-extensibility/custom-gpu-operations.rst b/docs/articles_en/documentation/openvino-extensibility/custom-gpu-operations.rst index 8e7f6f34e19..9c544d4dbb2 100644 --- a/docs/articles_en/documentation/openvino-extensibility/custom-gpu-operations.rst +++ b/docs/articles_en/documentation/openvino-extensibility/custom-gpu-operations.rst @@ -23,14 +23,14 @@ There are two options for using the custom operation configuration file: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/custom_kernels_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/custom_kernels_api.py :language: python :fragment: [part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/custom_kernels_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/custom_kernels_api.cpp :language: cpp :fragment: [part0] diff --git a/docs/articles_en/documentation/openvino-extensibility/frontend-extensions.rst b/docs/articles_en/documentation/openvino-extensibility/frontend-extensions.rst index 28b41aacf2d..78777e777fb 100644 --- a/docs/articles_en/documentation/openvino-extensibility/frontend-extensions.rst +++ b/docs/articles_en/documentation/openvino-extensibility/frontend-extensions.rst @@ -57,11 +57,11 @@ class that works well if all the following conditions are satisfied: The following example maps ONNX operation with the type of `Identity `__ to OpenVINO template extension ``Identity`` class. -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_Identity_header] -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_Identity] @@ -70,7 +70,7 @@ The mapping doesn’t involve any attributes, as operation Identity doesn’t ha Extension objects, like just constructed ``extension`` can be used to add to the OpenVINO runtime just before the loading a model that contains custom operations: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_read_model] @@ -99,14 +99,14 @@ In this case, you can directly say that 'MyRelu' -> ``Relu`` mapping should be u .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [py_frontend_extension_MyRelu] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_MyRelu] @@ -136,14 +136,14 @@ based on ``visit_attributes`` method that should be defined for any OpenVINO ope Imagine you have CustomOperation class implementation that has two attributes with names: ``attr1`` and ``attr2``. -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation] And original model in framework representation also has operation with name ``CustomOperation`` with the same ``attr1`` and ``attr2`` attributes. Then with the following code: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_as_is] @@ -152,7 +152,7 @@ Both ``attr1`` and ``attr2`` are copied from framework representation to OpenVIN If for some reason names of attributes are different but values still can be copied “as-is” you can pass attribute names mapping in ``OpExtension`` constructor: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_rename] @@ -162,7 +162,7 @@ If copying of an attribute is not what you need, ``OpExtension`` also can set at For the same ``CustomOperation``, imagine you want to set ``attr2`` to value 5 instead of copying from ``fw_attr2``, to achieve that do the following: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_rename_set] @@ -196,14 +196,14 @@ outputs map to OpenVINO ``CustomOperation`` first and second output respectively Given that, such custom operation can be registered by the following: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_as_is_paddle] Second example shows how to map the operation with named inputs and outputs, but when names of attributes are different: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_rename_paddle] @@ -211,7 +211,7 @@ Second example shows how to map the operation with named inputs and outputs, but and the last one shows how to map the operation with named inputs and outputs, but when (in order to correctly map framework operation to OpenVINO operation) one of the attributes has to be set to predefined value: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_CustomOperation_rename_set_paddle] @@ -234,7 +234,7 @@ with two attributes ``alpha`` and ``beta``: Below is a snippet of ``CustomElu`` class showing how to define its attributes: -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_framework_map_CustomElu] @@ -243,7 +243,7 @@ Let's see an example of how you can map ``CustomElu`` to PyTorch `aten::elu Multiply(x, C .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [py_frontend_extension_ThresholdedReLU_header] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_ThresholdedReLU_header] @@ -364,14 +364,14 @@ from ONNX according to the formula: ``ThresholdedRelu(x, alpha) -> Multiply(x, C .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_extensions.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [py_frontend_extension_ThresholdedReLU] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_extensions.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_ThresholdedReLU] @@ -381,7 +381,7 @@ The next example shows how to use ``ConversionExtension`` to convert PyTorch to demonstrate how to use ``get_values_from_const_input`` function to fetch an attribute value from input: -.. doxygensnippet:: docs/snippets/ov_extensions.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.py :language: python :fragment: [py_frontend_extension_aten_hardtanh] @@ -402,7 +402,7 @@ For PaddlePaddle operations, it is generally necessary to provide names for all Usually those names can be found in source code of the individual operation in PaddlePaddle code. The following example shows such conversion for the ``top_k_v2`` operation. -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_paddle_TopK] @@ -412,7 +412,7 @@ For a description of TensorFlow operations, including the names of their outputs `tf.raw_ops `__ documentation page. The next example shows such conversion for the ``TopKV2`` operation. -.. doxygensnippet:: docs/snippets/ov_extensions.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_extensions.cpp :language: cpp :fragment: [frontend_extension_tf_TopK] diff --git a/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations.rst b/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations.rst index 0bc70dd56dc..df0edd1f038 100644 --- a/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations.rst +++ b/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations.rst @@ -289,7 +289,7 @@ Step 1. Common optimizations This step is optional for LPT but typically is presented in OpenVINO™ plugins. The step doesn't use any LPT transformation. Firstly, the step disables dequantization operations constant folding on constant subgraph on weights to prevent the lost of dequantization info on the next plugin transformations. After that, it optimizes the transformation function and converts operations to operation set 1. Typically, usage of this step is the simplest way to meet LPT requirements for the input quantized model. If plugin can guarantee that LPT input requirements are met, then this step can be skipped. -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [lpt_common] @@ -297,7 +297,7 @@ Step 2. Low precision transformations execution +++++++++++++++++++++++++++++++++++++++++++++++ This step is mandatory. It configures and runs LPT transformations. -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [lpt_execution] @@ -306,7 +306,7 @@ Step 3. Plugin-specific transformations This step is optional. It modifies the transformation function to a device-specific operation set. -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [lpt_device] @@ -440,7 +440,7 @@ Operation precision restrictions This option defines precisions which allowed for the operation input ports. The option value is passed as input argument for ``LowPrecision`` constructor. For example: -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [lpt_supported_precisions] @@ -451,7 +451,7 @@ Operation per tensor quantization restrictions This option defines if operation supports per-tensor quantization only. The option value is passed as input argument for ``LowPrecision`` constructor. For example: -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [per_tensor_quantization] @@ -467,7 +467,7 @@ Typical customization use cases Plugin specific customization can be implemented via transformation callbacks. For example: asymmetric quantization support can be easily customizable via ``LayerTransformation::isAsymmetricQuantization`` and ``WeightableLayerTransformation::isAsymmetricOnWeights`` methods usage in callbacks. For example: -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [asymmetric_quantization] diff --git a/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations/step2-markup.rst b/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations/step2-markup.rst index 54e1a2b8b80..9c21b4a3492 100644 --- a/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations/step2-markup.rst +++ b/docs/articles_en/documentation/openvino-extensibility/openvino-plugin-library/advanced-guides/low-precision-transformations/step2-markup.rst @@ -99,7 +99,7 @@ The original model key features: Transformations are run with the following parameters: -.. doxygensnippet:: docs/snippets/lpt_intel_cpu_plugin.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/lpt_intel_cpu_plugin.cpp :language: cpp :fragment: [lpt_markup_pipeline] diff --git a/docs/articles_en/documentation/openvino-extensibility/transformation-api.rst b/docs/articles_en/documentation/openvino-extensibility/transformation-api.rst index 4a132322e91..2f6ea47c444 100644 --- a/docs/articles_en/documentation/openvino-extensibility/transformation-api.rst +++ b/docs/articles_en/documentation/openvino-extensibility/transformation-api.rst @@ -36,7 +36,7 @@ With output port we can set inputs for newly created operations. Lets look at the code example. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:ports_example] @@ -51,7 +51,7 @@ We will review real replacement case where Negative operation is replaced with M .. image:: ./../../_static/images/ov_replace_node.png -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:replace_node] @@ -59,7 +59,7 @@ We will review real replacement case where Negative operation is replaced with M The alternative way to do the same replacement is the following: -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:manual_replace] @@ -67,13 +67,13 @@ Another transformation example is insertion. .. image:: ./../../_static/images/ov_insert_node.png -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:insert_node] The alternative way to the insert operation is to make a node copy and use ``ov::replace_node()``: -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:insert_node_with_copy] @@ -84,7 +84,7 @@ Another type of node replacement is its elimination. To eliminate operation, OpenVINO™ has special method that considers all limitations related to OpenVINO™ Runtime. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:eliminate_node] @@ -124,7 +124,7 @@ When developing a transformation, you need to follow these transformation rules: Each ``ov::Node`` has an unique name and a friendly name. In transformations we care only about friendly name because it represents the name from the model. To avoid losing friendly name when replacing node with other node or subgraph, set the original friendly name to the latest node in replacing subgraph. See the example below. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:replace_friendly_name] @@ -139,7 +139,7 @@ In most cases, transformations have the following types: 1:1 (replace node with Currently, there is no mechanism that automatically detects transformation types, so we need to propagate this runtime information manually. See the examples below. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:copy_runtime_info] @@ -153,7 +153,7 @@ When transformation has multiple fusions or decompositions, ``ov::copy_runtime_i If your transformation inserts constant sub-graphs that need to be folded, do not forget to use ``ov::pass::ConstantFolding()`` after your transformation or call constant folding directly for operation. The example below shows how constant subgraph can be constructed. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:constant_subgraph] @@ -161,7 +161,7 @@ Manual constant folding is more preferable than ``ov::pass::ConstantFolding()`` Below you can find an example of manual constant folding: -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [manual_constant_folding] @@ -190,13 +190,13 @@ In addition, ``ov::pass::Manager`` has extended debug capabilities (find more in The example below shows basic usage of ``ov::pass::Manager`` -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:manager3] Another example shows how multiple matcher passes can be united into single GraphRewrite. -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:manager2] diff --git a/docs/articles_en/documentation/openvino-extensibility/transformation-api/graph-rewrite-pass.rst b/docs/articles_en/documentation/openvino-extensibility/transformation-api/graph-rewrite-pass.rst index 4a30dd1b6ec..82057f8cb15 100644 --- a/docs/articles_en/documentation/openvino-extensibility/transformation-api/graph-rewrite-pass.rst +++ b/docs/articles_en/documentation/openvino-extensibility/transformation-api/graph-rewrite-pass.rst @@ -12,7 +12,7 @@ OpenVINO Graph Rewrite Pass ``ov::pass::GraphRewrite`` serves for running multiple matcher passes on ``ov::Model`` in a single graph traversal. Example: -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:graph_rewrite] diff --git a/docs/articles_en/documentation/openvino-extensibility/transformation-api/matcher-pass.rst b/docs/articles_en/documentation/openvino-extensibility/transformation-api/matcher-pass.rst index 9a0f0ed9d53..559a717895e 100644 --- a/docs/articles_en/documentation/openvino-extensibility/transformation-api/matcher-pass.rst +++ b/docs/articles_en/documentation/openvino-extensibility/transformation-api/matcher-pass.rst @@ -13,11 +13,11 @@ OpenVINO Matcher Pass Template for MatcherPass transformation class -.. doxygensnippet:: docs/snippets/template_pattern_transformation.hpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.hpp :language: cpp :fragment: [graph_rewrite:template_transformation_hpp] -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [graph_rewrite:template_transformation_cpp] @@ -40,7 +40,7 @@ Then you need to take the last created operation and put it as a root of the pat .. note:: Any nodes in a pattern that have no consumers and are not registered as root will not be used in pattern matching. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [pattern:simple_example] @@ -53,7 +53,7 @@ Implement callback Callback is an action applied to every pattern entrance. In general, callback is the lambda function that takes Matcher object with detected subgraph. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [pattern:callback_example] @@ -70,7 +70,7 @@ That means that matcher passes registered in ``ov::pass::GraphRewrite`` will be The example below shows how single MatcherPass can fuse sequence of operations using the ``register_new_node`` method. -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:relu_fusion] @@ -99,19 +99,19 @@ MatcherPass has multiple ways to be executed: * Run on a single node - it can be useful if you want to run MatcherPass inside another transformation. -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:run_on_node] * Run on ``ov::Model`` using GraphRewrite - this approach gives ability to run MatcherPass on whole ``ov::Model``. Moreover, multiple MatcherPass transformation can be registered in a single GraphRewite to be executed in a single graph traversal. -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:graph_rewrite] * Run on ``ov::Model`` using ``ov::pass::Manager`` - this approach helps you to register MatcherPass for execution on ``ov::Model`` as another transformation types. -.. doxygensnippet:: docs/snippets/template_pattern_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_pattern_transformation.cpp :language: cpp :fragment: [matcher_pass:manager] @@ -137,19 +137,19 @@ The example below shows basic usage of ``ov::passpattern::any_input``. Here we construct Multiply pattern with arbitrary first input and Constant as a second input. Also as Multiply is commutative operation, it does not matter in which order we set inputs (any_input/Constant or Constant/any_input) because both cases will be matched. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [pattern:label_example] This example shows how we can construct a pattern when operation has arbitrary number of inputs. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [pattern:concat_example] This example shows how to use predicate to construct a pattern. Also it shows how to match pattern manually on given node. -.. doxygensnippet:: docs/snippets/ov_model_snippets.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [pattern:predicate_example] diff --git a/docs/articles_en/documentation/openvino-extensibility/transformation-api/model-pass.rst b/docs/articles_en/documentation/openvino-extensibility/transformation-api/model-pass.rst index 2f4fb90815f..c01b27e7aac 100644 --- a/docs/articles_en/documentation/openvino-extensibility/transformation-api/model-pass.rst +++ b/docs/articles_en/documentation/openvino-extensibility/transformation-api/model-pass.rst @@ -13,11 +13,11 @@ OpenVINO Model Pass Template for ModelPass transformation class -.. doxygensnippet:: docs/snippets/template_model_transformation.hpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_model_transformation.hpp :language: cpp :fragment: [model_pass:template_transformation_hpp] -.. doxygensnippet:: docs/snippets/template_model_transformation.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/template_model_transformation.cpp :language: cpp :fragment: [model_pass:template_transformation_cpp] diff --git a/docs/articles_en/documentation/openvino-security/openvino-encrypted-models.rst b/docs/articles_en/documentation/openvino-security/openvino-encrypted-models.rst index dfdc05e66d9..7a18392d2df 100644 --- a/docs/articles_en/documentation/openvino-security/openvino-encrypted-models.rst +++ b/docs/articles_en/documentation/openvino-security/openvino-encrypted-models.rst @@ -5,8 +5,8 @@ Using Encrypted Models with OpenVINO .. meta:: - :description: Learn how to encrypt and optimize a model before its deployment - to the edge device to ensure inference integrity and + :description: Learn how to encrypt and optimize a model before its deployment + to the edge device to ensure inference integrity and provide copyright protection. Deploying deep-learning capabilities to edge devices can present security challenges like ensuring inference integrity, or providing copyright protection of your deep-learning models. @@ -29,7 +29,7 @@ Loading Encrypted Models The OpenVINO Runtime requires model decryption before loading. Allocate a temporary memory block for model decryption and use the ``ov::Core::read_model`` method to load the model from a memory buffer. For more information, see the ``ov::Core`` Class Reference Documentation. -.. doxygensnippet:: docs/snippets/protecting_model_guide.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/protecting_model_guide.cpp :language: cpp :fragment: part0 @@ -39,7 +39,7 @@ Use the ``ov::Core::read_model`` to set model representations and weights respec Currently there is no way to read external weights from memory for ONNX models. The ``ov::Core::read_model(const std::string& model, const Tensor& weights)`` method should be called with ``weights`` passed as an empty ``ov::Tensor``. -.. doxygensnippet:: docs/snippets/protecting_model_guide.cpp +.. doxygensnippet:: docs/articles_en/assets/snippets/protecting_model_guide.cpp :language: cpp :fragment: part1 diff --git a/docs/articles_en/openvino-workflow/running-inference/changing-input-shape.rst b/docs/articles_en/openvino-workflow/running-inference/changing-input-shape.rst index 4ddfa5d8b7b..6e019d85c35 100644 --- a/docs/articles_en/openvino-workflow/running-inference/changing-input-shape.rst +++ b/docs/articles_en/openvino-workflow/running-inference/changing-input-shape.rst @@ -33,14 +33,14 @@ to set a new batch size with the ``reshape`` method: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ShapeInference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.py :language: Python :fragment: picture_snippet .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ShapeInference.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.cpp :language: cpp :fragment: picture_snippet @@ -62,14 +62,14 @@ When using the ``reshape`` method, you may take one of the approaches: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ShapeInference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.py :language: python :fragment: simple_spatials_change .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ShapeInference.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.cpp :language: cpp :fragment: spatial_reshape @@ -92,7 +92,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``openvino.runtime.Output`` dictionary key specifies input by passing actual input object. Dictionary values representing new shapes could be ``PartialShape``: - .. doxygensnippet:: docs/snippets/ShapeInference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.py :language: python :fragment: [obj_to_shape] @@ -101,7 +101,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``map, ov::PartialShape`` specifies input by passing actual input port: - .. doxygensnippet:: docs/snippets/ShapeInference.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.cpp :language: cpp :fragment: [obj_to_shape] @@ -115,7 +115,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``int`` dictionary key specifies input by its index. Dictionary values representing new shapes could be ``tuple``: - .. doxygensnippet:: docs/snippets/ShapeInference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.py :language: python :fragment: [idx_to_shape] @@ -124,7 +124,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``map`` specifies input by its index: - .. doxygensnippet:: docs/snippets/ShapeInference.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.cpp :language: cpp :fragment: [idx_to_shape] @@ -138,7 +138,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``str`` dictionary key specifies input by its name. Dictionary values representing new shapes could be ``str``: - .. doxygensnippet:: docs/snippets/ShapeInference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.py :language: python :fragment: [name_to_shape] @@ -147,7 +147,7 @@ When using the ``reshape`` method, you may take one of the approaches: ``map`` specifies input by its name: - .. doxygensnippet:: docs/snippets/ShapeInference.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ShapeInference.cpp :language: cpp :fragment: [name_to_shape] @@ -172,14 +172,14 @@ To change the batch dimension of the model, :ref:`set the layout `__, as shown in these examples: - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.c + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.c :language: cpp :fragment: ov_dynamic_shapes:reshape_bounds @@ -208,21 +208,21 @@ The sample below shows how a model can accept different input shapes. In the fir .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.py :language: python :fragment: set_input_tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.cpp :language: cpp :fragment: ov_dynamic_shapes:set_input_tensor .. tab-item:: C :sync: c - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.c + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.c :language: cpp :fragment: ov_dynamic_shapes:set_input_tensor @@ -243,21 +243,21 @@ To determine if the output has dynamic dimensions, the ``partial_shape`` propert .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.py :language: python :fragment: print_dynamic .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.cpp :language: cpp :fragment: ov_dynamic_shapes:print_dynamic .. tab-item:: C :sync: c - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.c + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.c :language: cpp :fragment: ov_dynamic_shapes:print_dynamic @@ -272,21 +272,21 @@ Output layers can also be checked for dynamic dimensions using the ``partial_sha .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.py :language: python :fragment: detect_dynamic .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.cpp :language: cpp :fragment: ov_dynamic_shapes:detect_dynamic .. tab-item:: C :sync: c - .. doxygensnippet:: docs/snippets/ov_dynamic_shapes.c + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_dynamic_shapes.c :language: cpp :fragment: ov_dynamic_shapes:detect_dynamic diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes.rst index 565a8f9b3c6..19328ec7a9c 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes.rst @@ -67,7 +67,7 @@ multi-device mode: .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/MULTI2.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/MULTI2.cpp :language: cpp :fragment: [part2] @@ -79,7 +79,7 @@ Accordingly, the code that loops over all available devices of the "GPU" type on .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/MULTI3.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/MULTI3.cpp :language: cpp :fragment: [part3] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection.rst index 80471869497..d20ec78f940 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection.rst @@ -202,14 +202,14 @@ The code samples on this page assume following import(Python)/using (C++) are in .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [py_ov_property_import_header] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO0.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO0.cpp :language: cpp :fragment: [py_ov_property_import_header] @@ -232,14 +232,14 @@ See the following code for using AUTO and specifying devices: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO0.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO0.cpp :language: cpp :fragment: [part0] @@ -392,14 +392,14 @@ To enable performance hints for your application, use the following code: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part3] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO3.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO3.cpp :language: cpp :fragment: [part3] @@ -420,14 +420,14 @@ The ``ov::hint::model_priority`` property enables you to control the priorities .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part4] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO4.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO4.cpp :language: cpp :fragment: [part4] @@ -443,14 +443,14 @@ To query the runtime target devices on which the inferences are being executed u .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part7] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO7.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO7.cpp :language: cpp :fragment: [part7] @@ -465,14 +465,14 @@ Although the methods described above are currently the preferred way to execute .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part5] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO5.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO5.cpp :language: cpp :fragment: [part5] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection/debugging-auto-device.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection/debugging-auto-device.rst index 357f4ff6987..b0cde79f630 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection/debugging-auto-device.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/auto-device-selection/debugging-auto-device.rst @@ -28,14 +28,14 @@ There are six levels of logs, which can be called explicitly or set via the ``OP .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto.py :language: python :fragment: [part6] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/AUTO6.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/AUTO6.cpp :language: cpp :fragment: [part6] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching.rst index 3182e0da7d4..b424648e385 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/automatic-batching.rst @@ -35,14 +35,14 @@ How Automatic Batching Works .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: Python :fragment: [compile_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [compile_model] @@ -58,14 +58,14 @@ How Automatic Batching Works .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: Python :fragment: [compile_model_no_auto_batching] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [compile_model_no_auto_batching] @@ -96,14 +96,14 @@ This "automatic batch size selection" works on the presumption that the applicat .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: Python :fragment: [query_optimal_num_requests] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [query_optimal_num_requests] @@ -124,14 +124,14 @@ For example, when the application processes only 4 video streams, there is no ne .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: Python :fragment: [hint_num_requests] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [hint_num_requests] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/cpu-device.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/cpu-device.rst index ede4765b67d..2d72b49fcf2 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/cpu-device.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/cpu-device.rst @@ -39,14 +39,14 @@ the ``ov::Core::compile_model()`` method: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_cpu.py :language: py :fragment: [compile_model_default] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_cpu.cpp :language: cpp :fragment: [compile_model_default] @@ -118,14 +118,14 @@ to query ``ov::device::capabilities`` property, which should contain ``FP16`` or .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference.py :language: py :fragment: [part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference0.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference0.cpp :language: cpp :fragment: [part0] @@ -141,14 +141,14 @@ the ``ov::CompiledModel::get_property`` call. The code below demonstrates how to .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference.py :language: py :fragment: [part1] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference1.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference1.cpp :language: cpp :fragment: [part1] @@ -160,14 +160,14 @@ To infer the model in ``f32`` precision instead of half-precision (``bf16`` or ` .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference.py + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference.py :language: py :fragment: [part2] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/Bfloat16Inference2.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/Bfloat16Inference2.cpp :language: cpp :fragment: [part2] @@ -211,14 +211,14 @@ This can be achieved by specifying ``MULTI:CPU,GPU.0`` as a target device in cas .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_cpu.py :language: py :fragment: [compile_model_multi] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_cpu.cpp :language: cpp :fragment: [compile_model_multi] @@ -261,14 +261,14 @@ with the static input shape to get the best performance. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/dynamic_shape.py + .. doxygensnippet:: docs/articles_en/assets/snippets/dynamic_shape.py :language: py :fragment: [static_shape] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/dynamic_shape.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/dynamic_shape.cpp :language: cpp :fragment: [static_shape] @@ -396,14 +396,14 @@ User can use the following properties to limit available CPU resource for model .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/multi_threading.py + .. doxygensnippet:: docs/articles_en/assets/snippets/multi_threading.py :language: python :fragment: [ov:intel_cpu:multi_threading:part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/multi_threading.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/multi_threading.cpp :language: cpp :fragment: [ov:intel_cpu:multi_threading:part0] @@ -415,7 +415,7 @@ User can use the following properties to limit available CPU resource for model In some use cases, OpenVINO Runtime will enable CPU threads pinning by default for better performance. User can also turn it on or off using property ``ov::hint::enable_cpu_pinning``. Disable threads pinning might be beneficial in complex applications with several workloads executed in parallel. The following table describes the default setting for ``ov::hint::enable_cpu_pinning`` in different use cases. ==================================================== ================================ - Use Case Default Setting of CPU Pinning + Use Case Default Setting of CPU Pinning ==================================================== ================================ All use cases with Windows OS False Stream contains both Pcore and Ecore with Linux OS False @@ -428,14 +428,14 @@ In some use cases, OpenVINO Runtime will enable CPU threads pinning by default f .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/multi_threading.py + .. doxygensnippet:: docs/articles_en/assets/snippets/multi_threading.py :language: python :fragment: [ov:intel_cpu:multi_threading:part1] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/multi_threading.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/multi_threading.cpp :language: cpp :fragment: [ov:intel_cpu:multi_threading:part1] @@ -480,14 +480,14 @@ To enable denormals optimization in the application, the ``denormals_optimizatio .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_denormals.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_denormals.py :language: python :fragment: [ov:intel_cpu:denormals_optimization:part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_denormals.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_denormals.cpp :language: cpp :fragment: [ov:intel_cpu:denormals_optimization:part0] @@ -524,14 +524,14 @@ Code examples of how to use ``sparse_weights_decompression_rate``: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/cpu/ov_sparse_weights_decompression.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_sparse_weights_decompression.py :language: python :fragment: [ov:intel_cpu:sparse_weights_decompression:part0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/cpu/ov_sparse_weights_decompression.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_sparse_weights_decompression.cpp :language: cpp :fragment: [ov:intel_cpu:sparse_weights_decompression:part0] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst index 023b2d1f189..0e3506484b4 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst @@ -59,14 +59,14 @@ Then, the device name can be passed to the ``ov::Core::compile_model()`` method, .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_default_gpu .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_default_gpu @@ -77,14 +77,14 @@ Then, the device name can be passed to the ``ov::Core::compile_model()`` method, .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_gpu_with_id .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_gpu_with_id @@ -95,14 +95,14 @@ Then, the device name can be passed to the ``ov::Core::compile_model()`` method, .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_gpu_with_id_and_tile .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_gpu_with_id_and_tile @@ -152,14 +152,14 @@ It is done by specifying ``MULTI:GPU.1,GPU.0`` as a target device. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_multi .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_multi @@ -183,14 +183,14 @@ Alternatively, it can be enabled explicitly via the device notion, for example ` .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_batch_plugin .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_batch_plugin @@ -201,14 +201,14 @@ Alternatively, it can be enabled explicitly via the device notion, for example ` .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/compile_model.py + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.py :language: Python :fragment: compile_model_auto_batch .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/compile_model.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/compile_model_gpu.cpp :language: cpp :fragment: compile_model_auto_batch @@ -275,14 +275,14 @@ The code snippet below demonstrates examples of a bounded dynamic batch: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/dynamic_batch.py + .. doxygensnippet:: docs/articles_en/assets/snippets/dynamic_batch.py :language: Python :fragment: dynamic_batch .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/dynamic_batch.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/dynamic_batch.cpp :language: cpp :fragment: dynamic_batch @@ -351,14 +351,14 @@ The GPU plugin has the following additional preprocessing options: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes.py + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.py :language: Python :fragment: init_preproc .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp :language: cpp :fragment: init_preproc diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device/remote-tensor-api-gpu-plugin.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device/remote-tensor-api-gpu-plugin.rst index 0b058cd1f9b..9af801ae986 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device/remote-tensor-api-gpu-plugin.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device/remote-tensor-api-gpu-plugin.rst @@ -61,21 +61,21 @@ of ``ov::RemoteContext`` derived classes. .. tab-item:: Create from cl_context :sync: create-from-cl-context - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_cl_context] .. tab-item:: Create from cl_queue :sync: create-from-cl-queue - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_cl_queue] .. tab-item:: Create from ID3D11Device :sync: create-from-id3d11device - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_d3d_device] @@ -87,21 +87,21 @@ of ``ov::RemoteContext`` derived classes. .. tab-item:: Create from cl_context :sync: create-from-cl-context - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_cl_context] .. tab-item:: Create from cl_queue :sync: create-from-cl-queue - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_cl_queue] .. tab-item:: Create from ID3D11Device :sync: create-from-id3d11device - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_d3d_device] @@ -113,21 +113,21 @@ of ``ov::RemoteContext`` derived classes. .. tab-item:: Create from cl_context :sync: create-from-cl-context - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_cl_context] .. tab-item:: Create from cl_queue :sync: create-from-cl-queue - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_cl_queue] .. tab-item:: Create from VADisplay :sync: create-from-vadisplay - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [context_from_va_display] @@ -139,21 +139,21 @@ of ``ov::RemoteContext`` derived classes. .. tab-item:: Create from cl_context :sync: create-from-cl-context - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_cl_context] .. tab-item:: Create from cl_queue :sync: create-from-cl-queue - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_cl_queue] .. tab-item:: Create from VADisplay :sync: create-from-vadisplay - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [context_from_va_display] @@ -177,14 +177,14 @@ To request the current default context of the plugin, use one of the following m .. tab-item:: Get context from Core :sync: get-context-core - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [default_context_from_core] .. tab-item:: Get context from compiled model :sync: get-context-compiled-model - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [default_context_from_model] @@ -196,14 +196,14 @@ To request the current default context of the plugin, use one of the following m .. tab-item:: Get context from Core :sync: get-context-core - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [default_context_from_core] .. tab-item:: Get context from compiled model :sync: get-context-compiled-model - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [default_context_from_model] @@ -231,35 +231,35 @@ For more details, see the code snippets below: .. tab-item:: USM pointer :sync: usm-pointer - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [wrap_usm_pointer] .. tab-item:: cl_mem :sync: cl-mem - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [wrap_cl_mem] .. tab-item:: cl::Buffer :sync: buffer - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [wrap_cl_buffer] .. tab-item:: cl::Image2D :sync: image2D - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [wrap_cl_image] .. tab-item:: biplanar NV12 surface :sync: biplanar-nv12-surface - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [wrap_nv12_surface] @@ -271,21 +271,21 @@ For more details, see the code snippets below: .. tab-item:: USM host memory :sync: usm-host-memory - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [allocate_usm_host] .. tab-item:: USM device memory :sync: usm-device-memory - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [allocate_usm_device] .. tab-item:: cl::Buffer :sync: buffer - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation.cpp :language: cpp :fragment: [allocate_cl_buffer] @@ -299,35 +299,35 @@ For more details, see the code snippets below: .. tab-item:: USM pointer :sync: usm-pointer - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [wrap_usm_pointer] .. tab-item:: cl_mem :sync: cl-mem - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [wrap_cl_mem] .. tab-item:: cl::Buffer :sync: buffer - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [wrap_cl_buffer] .. tab-item:: cl::Image2D :sync: image2D - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [wrap_cl_image] .. tab-item:: biplanar NV12 surface :sync: biplanar-nv12-surface - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [create_nv12_surface] @@ -339,14 +339,14 @@ For more details, see the code snippets below: .. tab-item:: USM host memory :sync: usm-host-memory - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [allocate_usm_host] .. tab-item:: USM device memory :sync: usm-device-memory - .. doxygensnippet:: docs/snippets/gpu/remote_objects_creation_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/remote_objects_creation_c.cpp :language: c :fragment: [allocate_usm_device] @@ -379,28 +379,28 @@ should be added before model compilation: .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp :language: cpp :fragment: [init_preproc] .. tab-item:: C :sync: c - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes_c.cpp :language: c :fragment: [init_preproc] .. tab-item:: single-plane :sync: single-plane - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_single_plane.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_single_plane.cpp :language: cpp :fragment: [init_preproc] .. tab-item:: NV12 to Grey :sync: nv12-grey - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_to_gray.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_to_gray.cpp :language: cpp :fragment: [init_preproc] @@ -424,28 +424,28 @@ inputs need to be set via the ``ov::InferRequest::set_tensors`` method with vect .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp :language: cpp :fragment: [single_batch] .. tab-item:: C :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes_c.cpp :language: c :fragment: [single_batch] .. tab-item:: single-plane :sync: single-plane - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_single_plane.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_single_plane.cpp :language: cpp :fragment: [single_batch] .. tab-item:: NV12 to Grey :sync: nv12-grey - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_to_gray.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_to_gray.cpp :language: cpp :fragment: [single_batch] @@ -457,21 +457,21 @@ inputs need to be set via the ``ov::InferRequest::set_tensors`` method with vect .. tab-item:: two-plane :sync: two-plane - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_two_planes.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_two_planes.cpp :language: cpp :fragment: [batched_case] .. tab-item:: single-plane :sync: single-plane - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_single_plane.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_single_plane.cpp :language: cpp :fragment: [batched_case] .. tab-item:: NV12 to Grey :sync: nv12-grey - .. doxygensnippet:: docs/snippets/gpu/preprocessing_nv12_to_gray.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/preprocessing_nv12_to_gray.cpp :language: cpp :fragment: [batched_case] @@ -492,7 +492,7 @@ on waiting for the completion of inference. The pseudo-code may look as follows: .. dropdown:: Queue and context sharing example - .. doxygensnippet:: docs/snippets/gpu/queue_sharing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/queue_sharing.cpp :language: cpp :fragment: [queue_sharing] @@ -533,13 +533,13 @@ To see pseudo-code of usage examples, refer to the sections below. This example uses the OpenCL context obtained from a compiled model object. - .. doxygensnippet:: docs/snippets/gpu/context_sharing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/context_sharing.cpp :language: cpp :fragment: [context_sharing_get_from_ov] .. dropdown:: Running GPU Plugin Inference within User-Supplied Shared Context - .. doxygensnippet:: docs/snippets/gpu/context_sharing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/context_sharing.cpp :language: cpp :fragment: [context_sharing_user_handle] @@ -550,14 +550,14 @@ To see pseudo-code of usage examples, refer to the sections below. .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/gpu/context_sharing_va.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/context_sharing_va.cpp :language: cpp :fragment: [context_sharing_va] .. tab-item:: C :sync: c - .. doxygensnippet:: docs/snippets/gpu/context_sharing_va_c.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/context_sharing_va_c.cpp :language: c :fragment: [context_sharing_va] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/hetero-execution.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/hetero-execution.rst index 1842abe2264..0ba7d26436e 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/hetero-execution.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/hetero-execution.rst @@ -53,14 +53,14 @@ Randomly selecting operations and setting affinities may lead to decrease in mod .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_hetero.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.py :language: Python :fragment: [set_manual_affinities] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_hetero.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.cpp :language: cpp :fragment: [set_manual_affinities] @@ -79,14 +79,14 @@ It does not take into account device peculiarities such as the inability to infe .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_hetero.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.py :language: Python :fragment: [compile_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_hetero.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.cpp :language: cpp :fragment: [compile_model] @@ -102,14 +102,14 @@ In some cases you may need to consider manually adjusting affinities which were .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_hetero.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.py :language: Python :fragment: [fix_automatic_affinities] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_hetero.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.cpp :language: cpp :fragment: [fix_automatic_affinities] @@ -131,14 +131,14 @@ If you want different devices in Hetero execution to have different device-speci .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_hetero.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.py :language: Python :fragment: [configure_fallback_devices] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_hetero.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_hetero.cpp :language: cpp :fragment: [configure_fallback_devices] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/multi-device.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/multi-device.rst index 30bf1abf3f7..6771f834a5b 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/multi-device.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/multi-device.rst @@ -58,14 +58,14 @@ The following commands are accepted by the API: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_multi.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_multi.py :language: python :fragment: [MULTI_0] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/MULTI0.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/MULTI0.cpp :language: cpp :fragment: [part0] @@ -83,14 +83,14 @@ As mentioned previously, executing inference with MULTI may be set up by configu .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_multi.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_multi.py :language: python :fragment: [MULTI_4] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/MULTI4.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/MULTI4.cpp :language: cpp :fragment: [part4] @@ -107,7 +107,7 @@ using the :doc:`configure devices ` property: .. tab-item:: C++ - .. doxygensnippet:: docs/snippets/MULTI5.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/MULTI5.cpp :language: cpp :fragment: [part5] diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/query-device-properties.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/query-device-properties.rst index 0d7f271d23d..6cc95a996bc 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/query-device-properties.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/query-device-properties.rst @@ -50,14 +50,14 @@ devices enabled by OpenVINO plugins and returns information, using the ``ov::Cor .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [get_available_devices] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [get_available_devices] @@ -109,14 +109,14 @@ The code below demonstrates how to query ``HETERO`` device priority of devices w .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [hetero_priorities] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [hetero_priorities] @@ -134,14 +134,14 @@ supported properties (``ov::supported_properties``), and others, use the ``ov::C .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [cpu_device_name] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [cpu_device_name] @@ -172,14 +172,14 @@ accept a selection of properties as last arguments. Each of the properties shoul .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [compile_model_with_property] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [compile_model_with_property] @@ -200,14 +200,14 @@ However, setting properties on a specific ``ov::Core::compile_model`` call appli .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [core_set_property_then_compile] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [core_set_property_then_compile] @@ -227,14 +227,14 @@ compiled model level property such as ``ov::optimal_number_of_infer_requests``: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [optimal_number_of_infer_requests] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [optimal_number_of_infer_requests] @@ -247,14 +247,14 @@ Or the number of threads that would be used for inference on ``CPU`` device: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [inference_num_threads] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [inference_num_threads] @@ -270,14 +270,14 @@ The only mode that supports this method is `Multi-Device execution <./multi-devi .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_properties_api.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.py :language: py :fragment: [multi_device] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_properties_api.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_properties_api.cpp :language: cpp :fragment: [multi_device] diff --git a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/inference-request.rst b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/inference-request.rst index 9f7525ece85..6ffbe06a0d2 100644 --- a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/inference-request.rst +++ b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/inference-request.rst @@ -5,8 +5,8 @@ OpenVINO™ Inference Request .. meta:: - :description: Infer Request mechanism in OpenVINO™ Runtime allows inferring - models on different devices in asynchronous or synchronous + :description: Infer Request mechanism in OpenVINO™ Runtime allows inferring + models on different devices in asynchronous or synchronous modes of inference. @@ -25,14 +25,14 @@ The ``ov::InferRequest`` can be created from the ``ov::CompiledModel``: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: create_infer_request .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: create_infer_request @@ -53,14 +53,14 @@ You can use ``ov::InferRequest::infer``, which blocks the application execution, .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: sync_infer .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: sync_infer @@ -76,14 +76,14 @@ The asynchronous mode can improve application's overall frame-rate, by making it .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: async_infer .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: async_infer @@ -97,14 +97,14 @@ Asynchronous mode supports two ways the application waits for inference results: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: wait_for .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: wait_for @@ -116,14 +116,14 @@ Asynchronous mode supports two ways the application waits for inference results: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: wait .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: wait @@ -139,14 +139,14 @@ When you are running several inference requests in parallel, a device can proces .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: set_callback .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: set_callback @@ -166,14 +166,14 @@ You can use the ``ov::InferRequest::cancel`` method if you want to abort executi .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: cancel .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: cancel @@ -193,14 +193,14 @@ Working with Input and Output tensors .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: get_set_one_tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: get_set_one_tensor @@ -213,14 +213,14 @@ Working with Input and Output tensors .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: get_set_index_tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: get_set_index_tensor @@ -233,14 +233,14 @@ Working with Input and Output tensors .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: get_set_tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: get_set_tensor @@ -253,14 +253,14 @@ Working with Input and Output tensors .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: get_set_tensor_by_port .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: get_set_tensor_by_port @@ -282,14 +282,14 @@ In this case, you can get the output tensor from the first request, using ``ov:: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: cascade_models .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: cascade_models @@ -305,7 +305,7 @@ It is possible to re-use shared input in several models. You do not need to allo .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: roi_tensor @@ -313,7 +313,7 @@ It is possible to re-use shared input in several models. You do not need to allo .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: roi_tensor @@ -328,14 +328,14 @@ By using ``ov::RemoteContext`` you can create a remote tensor to work with remot .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_infer_request.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.py :language: python :fragment: remote_tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_infer_request.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_infer_request.cpp :language: cpp :fragment: remote_tensor diff --git a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation.rst b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation.rst index cc5d2061eea..7fa87739a98 100644 --- a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation.rst +++ b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/model-representation.rst @@ -30,14 +30,14 @@ OpenVINO™ Runtime enables you to use different approaches to work with model i .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: cpp :fragment: [all_inputs_ouputs] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [all_inputs_ouputs] @@ -140,14 +140,14 @@ the conversion will throw an exception. For example: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: python :fragment: [ov:partial_shape] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:partial_shape] @@ -189,14 +189,14 @@ To build an ``ov::Model`` instance from ``opset8`` operations, include the follo .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: cpp :fragment: [import] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:include] @@ -208,14 +208,14 @@ The following code demonstrates how to create a simple model: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: cpp :fragment: [ov:create_simple_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:create_simple_model] @@ -227,14 +227,14 @@ The following code creates a model with several outputs: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: cpp :fragment: [ov:create_advanced_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:create_advanced_model] @@ -254,14 +254,14 @@ OpenVINO™ provides several debug capabilities: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: python :fragment: [ov:visualize] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:visualize] @@ -290,14 +290,14 @@ OpenVINO™ provides several debug capabilities: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_model_snippets.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.py :language: python :fragment: [ov:serialize] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_model_snippets.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_model_snippets.cpp :language: cpp :fragment: [ov:serialize] diff --git a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-advanced-inference.rst b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-advanced-inference.rst index 5a0660ed460..32230a0aedf 100644 --- a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-advanced-inference.rst +++ b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-advanced-inference.rst @@ -5,16 +5,16 @@ OpenVINO™ Runtime Python API Advanced Inference .. meta:: - :description: OpenVINO™ Runtime Python API enables you to share memory on inputs, hide + :description: OpenVINO™ Runtime Python API enables you to share memory on inputs, hide the latency with asynchronous calls and implement "postponed return". -.. warning:: - - All mentioned methods are very dependent on a specific hardware and software set-up. +.. warning:: + + All mentioned methods are very dependent on a specific hardware and software set-up. Consider conducting your own experiments with various models and different input/output - sizes. The methods presented here are not universal, they may or may not apply to the - specific pipeline. Please consider all tradeoffs and avoid premature optimizations. + sizes. The methods presented here are not universal, they may or may not apply to the + specific pipeline. Please consider all tradeoffs and avoid premature optimizations. Direct Inference with ``CompiledModel`` @@ -23,7 +23,7 @@ Direct Inference with ``CompiledModel`` The ``CompiledModel`` class provides the ``__call__`` method that runs a single synchronous inference using the given model. In addition to a compact code, all future calls to ``CompiledModel.__call__`` will result in less overhead, as the object reuses the already created ``InferRequest``. -.. doxygensnippet:: docs/snippets/ov_python_inference.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_inference.py :language: python :fragment: [direct_inference] @@ -31,31 +31,31 @@ The ``CompiledModel`` class provides the ``__call__`` method that runs a single Shared Memory on Inputs and Outputs ################################### -While using ``CompiledModel``, ``InferRequest`` and ``AsyncInferQueue``, -OpenVINO™ Runtime Python API provides an additional mode - "Shared Memory". -Specify the ``share_inputs`` and ``share_outputs`` flag to enable or disable this feature. +While using ``CompiledModel``, ``InferRequest`` and ``AsyncInferQueue``, +OpenVINO™ Runtime Python API provides an additional mode - "Shared Memory". +Specify the ``share_inputs`` and ``share_outputs`` flag to enable or disable this feature. The "Shared Memory" mode may be beneficial when inputs or outputs are large and copying data is considered an expensive operation. -This feature creates shared ``Tensor`` -instances with the "zero-copy" approach, reducing overhead of setting inputs +This feature creates shared ``Tensor`` +instances with the "zero-copy" approach, reducing overhead of setting inputs to minimum. For outputs this feature creates numpy views on data. Example usage: -.. doxygensnippet:: docs/snippets/ov_python_inference.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_inference.py :language: python :fragment: [shared_memory_inference] -.. note:: +.. note:: - "Shared Memory" on inputs is enabled by default in ``CompiledModel.__call__``. - For other methods, like ``InferRequest.infer`` or ``InferRequest.start_async``, + "Shared Memory" on inputs is enabled by default in ``CompiledModel.__call__``. + For other methods, like ``InferRequest.infer`` or ``InferRequest.start_async``, it is required to set the flag to ``True`` manually. "Shared Memory" on outputs is disabled by default in all sequential inference methods (``CompiledModel.__call__`` and ``InferRequest.infer``). It is required to set the flag to ``True`` manually. -.. warning:: +.. warning:: - When data is being shared, all modifications (including subsequent inference calls) may affect inputs and outputs of the inference! + When data is being shared, all modifications (including subsequent inference calls) may affect inputs and outputs of the inference! Use this feature with caution, especially in multi-threaded/parallel code, where data can be modified outside of the function's control flow. @@ -63,18 +63,18 @@ to minimum. For outputs this feature creates numpy views on data. Example usage: Hiding Latency with Asynchronous Calls ###################################### -Asynchronous calls allow to hide latency to optimize overall runtime of a codebase. -For example, ``InferRequest.start_async`` releases the GIL and provides non-blocking call. +Asynchronous calls allow to hide latency to optimize overall runtime of a codebase. +For example, ``InferRequest.start_async`` releases the GIL and provides non-blocking call. It is beneficial to process other calls while waiting to finish compute-intensive inference. Example usage: -.. doxygensnippet:: docs/snippets/ov_python_inference.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_inference.py :language: python :fragment: [hiding_latency] -.. note:: - +.. note:: + It is up to the user/developer to optimize the flow in a codebase to benefit from potential parallelization. @@ -89,8 +89,8 @@ synchronous calls. "Postponed Return" could be applied when: * data return is not required at all. For example, models are being chained with the pure ``Tensor`` interface. -.. doxygensnippet:: docs/snippets/ov_python_inference.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_inference.py :language: python :fragment: [no_return_inference] - + diff --git a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-exclusives.rst b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-exclusives.rst index 524d4866e32..11df44a0b0d 100644 --- a/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-exclusives.rst +++ b/docs/articles_en/openvino-workflow/running-inference/integrate-openvino-with-your-application/python-api-exclusives.rst @@ -18,7 +18,7 @@ Easier Model Compilation ``CompiledModel`` can be easily created with the helper method. It hides the creation of ``Core`` and applies ``AUTO`` inference mode by default. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [auto_compilation] @@ -29,7 +29,7 @@ Model/CompiledModel Inputs and Outputs Besides functions aligned to C++ API, some of them have their Python counterparts or extensions. For example, ``Model`` and ``CompiledModel`` inputs/outputs can be accessed via properties. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [properties_example] @@ -44,7 +44,7 @@ Working with Tensor Python API allows passing data as tensors. The ``Tensor`` object holds a copy of the data from the given array. The ``dtype`` of *numpy* arrays is converted to OpenVINO™ types automatically. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [tensor_basics] @@ -55,7 +55,7 @@ Shared Memory Mode ``Tensor`` objects can share the memory with *numpy* arrays. By specifying the ``shared_memory`` argument, the ``Tensor`` object does not copy data. Instead, it has access to the memory of the *numpy* array. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [tensor_shared_mode] @@ -68,7 +68,7 @@ Python API supports extra calling methods to synchronous and asynchronous modes All infer methods allow users to pass data as popular *numpy* arrays, gathered in either Python dicts or lists. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [passing_numpy_array] @@ -76,7 +76,7 @@ All infer methods allow users to pass data as popular *numpy* arrays, gathered i Results from inference can be obtained in various ways: -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [getting_results] @@ -87,7 +87,7 @@ Synchronous Mode - Extended Python API provides different synchronous calls to infer model, which block the application execution. Additionally, these calls return results of inference: -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [sync_infer] @@ -99,7 +99,7 @@ Inference Results - OVDict Synchronous calls return a special data structure called ``OVDict``. It can be compared to a "frozen dictionary". There are various ways of accessing the object's elements: -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [ov_dict] @@ -126,7 +126,7 @@ Each job is distinguishable by a unique ``id``, which is in the range from 0 up The ``start_async`` function call is not required to be synchronized - it waits for any available job if the queue is busy/overloaded. Every ``AsyncInferQueue`` code block should end with the ``wait_all`` function which provides the "global" synchronization of all jobs in the pool and ensure that access to them is safe. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [asyncinferqueue] @@ -141,7 +141,7 @@ Acquiring Results from Requests After the call to ``wait_all``, jobs and their data can be safely accessed. Acquiring a specific job with ``[id]`` will return the ``InferRequest`` object, which will result in seamless retrieval of the output data. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [asyncinferqueue_access] @@ -154,7 +154,7 @@ Another feature of ``AsyncInferQueue`` is the ability to set callbacks. When cal The callback of ``AsyncInferQueue`` is uniform for every job. When executed, GIL is acquired to ensure safety of data manipulation inside the function. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [asyncinferqueue_set_callback] @@ -166,7 +166,7 @@ Since OpenVINO™ supports low precision element types, there are a few ways to To create an input tensor with such element types, you may need to pack your data in the new *numpy* array, with which the byte size matches the original input size: -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [packing_data] @@ -174,7 +174,7 @@ To create an input tensor with such element types, you may need to pack your dat To extract low precision values from a tensor into the *numpy* array, you can use the following helper: -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [unpacking] @@ -185,7 +185,7 @@ Release of GIL Some functions in Python API release the Global Lock Interpreter (GIL) while running work-intensive code. This can help you achieve more parallelism in your application, using Python threads. For more information about GIL, refer to the `Python API documentation <../../../api/ie_python_api/api.html>`__. -.. doxygensnippet:: docs/snippets/ov_python_exclusives.py +.. doxygensnippet:: docs/articles_en/assets/snippets/ov_python_exclusives.py :language: python :fragment: [releasing_gil] diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/general-optimizations.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/general-optimizations.rst index e8988e7fe9c..080c297ed25 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/general-optimizations.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/general-optimizations.rst @@ -50,13 +50,13 @@ Below are example-codes for the regular and async-based approaches to compare: * Normally, the frame is captured with OpenCV and then immediately processed: - .. doxygensnippet:: docs/snippets/dldt_optimization_guide8.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/dldt_optimization_guide8.cpp :language: cpp :fragment: [part8] * In the "true" async mode, the ``NEXT`` request is populated in the main (application) thread, while the ``CURRENT`` request is processed: - .. doxygensnippet:: docs/snippets/dldt_optimization_guide9.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/dldt_optimization_guide9.cpp :language: cpp :fragment: [part9] diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/high-level-performance-hints.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/high-level-performance-hints.rst index 958e585e5de..b2b846e8cf7 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/high-level-performance-hints.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/high-level-performance-hints.rst @@ -62,14 +62,14 @@ In the example code snippet below, ``ov::hint::PerformanceMode::THROUGHPUT`` is .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: python :fragment: [compile_model] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [compile_model] @@ -85,14 +85,14 @@ As mentioned earlier, this will limit the batch size for the GPU and the number .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: python :fragment: [hint_num_requests] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [hint_num_requests] @@ -107,14 +107,14 @@ The hints are used on the presumption that the application queries ``ov::optimal .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: python :fragment: [query_optimal_num_requests] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [query_optimal_num_requests] @@ -148,14 +148,14 @@ For example, use ``ov::hint::PerformanceMode::THROUGHPUT`` to prepare a general .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_auto_batching.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.py :language: python :fragment: [hint_plus_low_level] .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_auto_batching.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_auto_batching.cpp :language: cpp :fragment: [hint_plus_low_level] diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing.rst index f9b04f53afb..f3431bfd10b 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing.rst @@ -66,14 +66,14 @@ The ``ov::preprocess::PrePostProcessor`` class allows specifying preprocessing a .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:create .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:create @@ -89,14 +89,14 @@ To address particular input of a model/preprocessor, use the ``ov::preprocess::P .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:tensor .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:tensor @@ -122,14 +122,14 @@ Model input already has information about precision and shape. Preprocessing API .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:model .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:model @@ -147,14 +147,14 @@ Now, the sequence of preprocessing steps can be defined: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:steps .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:steps @@ -179,14 +179,14 @@ Once the preprocessing steps have been finished the model can be finally built. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:build .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:build diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/integrate-save-preprocessing-use-case.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/integrate-save-preprocessing-use-case.rst index 0fb49cb0b08..aeb59c2e37a 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/integrate-save-preprocessing-use-case.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/integrate-save-preprocessing-use-case.rst @@ -10,7 +10,7 @@ Use Case - Integrate and Save Preprocessing Steps Into IR OpenVINO Intermediate Representation. -Previous sections covered the topic of the :doc:`preprocessing steps ` +Previous sections covered the topic of the :doc:`preprocessing steps ` and the overview of :doc:`Layout ` API. For many applications, it is also important to minimize read/load time of a model. @@ -19,8 +19,8 @@ startup, after ``ov::runtime::Core::read_model``, may seem inconvenient. In such once pre and postprocessing steps have been added, it can be useful to store new execution model to OpenVINO Intermediate Representation (OpenVINO IR, `.xml` format). -Most available preprocessing steps can also be performed via command-line options, -using Model Optimizer. For details on such command-line options, refer to the +Most available preprocessing steps can also be performed via command-line options, +using Model Optimizer. For details on such command-line options, refer to the :doc:`Optimizing Preprocessing Computation <../../../../documentation/legacy-features/transition-legacy-conversion-api/legacy-conversion-api/[legacy]-embedding-preprocessing-computation>`. Code example - Saving Model with Preprocessing to OpenVINO IR @@ -48,14 +48,14 @@ in the model preparation script for such a case. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: Python :fragment: ov:preprocess:save_headers .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:save_headers @@ -68,14 +68,14 @@ in the model preparation script for such a case. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: Python :fragment: ov:preprocess:save_model .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:save_model @@ -83,8 +83,8 @@ in the model preparation script for such a case. Application Code - Load Model to Target Device ############################################## -After this, the application code can load a saved file and stop preprocessing. In this case, enable -:doc:`model caching <../optimizing-latency/model-caching-overview>` to minimize load +After this, the application code can load a saved file and stop preprocessing. In this case, enable +:doc:`model caching <../optimizing-latency/model-caching-overview>` to minimize load time when the cached model is available. @@ -93,14 +93,14 @@ time when the cached model is available. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: Python :fragment: ov:preprocess:save_load .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:save_load diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/layout-api-overview.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/layout-api-overview.rst index 415fff12076..68e4abd5283 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/layout-api-overview.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/layout-api-overview.rst @@ -38,14 +38,14 @@ The easiest way is to fully specify each dimension with one alphabet letter. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:simple .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:simple @@ -63,14 +63,14 @@ The advanced syntax allows assigning a word to a dimension. To do this, wrap a l .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:complex .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:complex @@ -86,14 +86,14 @@ If a certain dimension is not important, its name can be set to ``?``. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:partially_defined .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:partially_defined @@ -109,14 +109,14 @@ If several dimensions are not important, an ellipsis ``...`` can be used to spec .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:dynamic .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:dynamic @@ -140,14 +140,14 @@ These names are used in :doc:`PreProcessing API <../optimize-preprocessing>`. Th .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:predefined .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:predefined @@ -168,14 +168,14 @@ A layout can be converted to a string in the advanced syntax format. It can be u .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:dump .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:dump @@ -191,14 +191,14 @@ OpenVINO provides helpers which provide a simple interface to get layout from Mo .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_layout.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.py :language: python :fragment: ov:layout:get_from_model .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_layout.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_layout.cpp :language: cpp :fragment: ov:layout:get_from_model diff --git a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/preprocessing-api-details.rst b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/preprocessing-api-details.rst index 214175e3dab..cb03e3b4e81 100644 --- a/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/preprocessing-api-details.rst +++ b/docs/articles_en/openvino-workflow/running-inference/optimize-inference/optimize-preprocessing/preprocessing-api-details.rst @@ -26,14 +26,14 @@ If the model has only one input, then simple ``ov::preprocess::PrePostProcessor: .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:input_1 .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:input_1 @@ -46,14 +46,14 @@ In general, when a model has multiple inputs/outputs, each one can be addressed .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:input_name .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:input_name @@ -65,14 +65,14 @@ Or by it's index. .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:input_index .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:input_index @@ -101,14 +101,14 @@ Typical data normalization includes 2 operations for each data item: subtract me .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:mean_scale .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:mean_scale @@ -121,14 +121,14 @@ In Computer Vision area normalization is usually done separately for R, G, B val .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:mean_scale_array .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:mean_scale_array @@ -152,14 +152,14 @@ To integrate precision conversion into an execution graph as a pre-processing st .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:convert_element_type .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:convert_element_type @@ -185,14 +185,14 @@ Conversion can be done implicitly, using the :doc:`layout ` .. tab-item:: Python :sync: py - .. doxygensnippet:: docs/snippets/ov_preprocessing.py + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.py :language: python :fragment: ov:preprocess:convert_layout .. tab-item:: C++ :sync: cpp - .. doxygensnippet:: docs/snippets/ov_preprocessing.cpp + .. doxygensnippet:: docs/articles_en/assets/snippets/ov_preprocessing.cpp :language: cpp :fragment: ov:preprocess:convert_layout @@ -205,14 +205,14 @@ For a manual transpose of axes without the use of a :doc:`layout - -int main() { - //! [ngraph:graph] - // _____________ _____________ - // | Parameter | | Parameter | - // | data1 | | data2 | - // |___________| |___________| - // | | - // data1_t | | data2_t - // \ / - // \ / - // \ / - // ____\____/____ - // | Concat | - // | concat | - // |____________| - // | - // | concat_t - // | - // _______|_______ - // | Result | - // | result | - // |_____________| - auto data1 = std::make_shared(ov::element::i64, ov::Shape{1, 3, 2, 2}); - data1->set_friendly_name("data1"); // operation name - data1->output(0).set_names({"data1_t"}); // tensor names - auto data2 = std::make_shared(ov::element::i64, ov::Shape{1, 2, 2, 2}); - data2->set_friendly_name("data2"); // operation name - data2->output(0).set_names({"data2_t"}); // tensor names - - auto concat = std::make_shared(ov::OutputVector{data1, data2}, 1); - concat->set_friendly_name("concat"); // operation name - concat->output(0).set_names({"concat_t"}); // tensor name - - auto result = std::make_shared(concat); - result->set_friendly_name("result"); // operation name - - auto f = std::make_shared(ov::ResultVector{result}, ov::ParameterVector{data1, data2}, "function_name"); - //! [ngraph:graph] - return 0; -} diff --git a/docs/snippets/ov_model_with_state_infer.py b/docs/snippets/ov_model_with_state_infer.py deleted file mode 100644 index f51d03ee5be..00000000000 --- a/docs/snippets/ov_model_with_state_infer.py +++ /dev/null @@ -1,82 +0,0 @@ -# Copyright (C) 2018-2024 Intel Corporation -# SPDX-License-Identifier: Apache-2.0 - -import logging as log -import numpy as np -import sys - -import openvino as ov -from openvino.runtime import opset12 as ops - - -def main(): - # 1. Load inference engine - log.info("Loading OpenVINO") - core = ov.Core() - - #! [ov:model_create] - # 2. Creating ov.Model - input = ops.parameter([1, 1], dtype=np.float32, name="data") - init_const = ops.constant([[0]], dtype=np.float32) - read = ops.read_value(init_const, "variable0", "f32", [1, 1]) - add = ops.add(input, read) - assign = ops.assign(add, "variable0") - add2 = ops.add(add, read) - result = ops.result(add2) - model = ov.Model(results=[result], sinks=[assign], parameters=[input], name="model") - #! [ov:model_create] - - log.info("Loading network files") - - # 3. Load network to CPU - compiled_model = core.compile_model(model, "CPU") - # 4. Create Infer Request - infer_request = compiled_model.create_infer_request() - - # 5. Prepare inputs - input_tensors = [] - for input in compiled_model.inputs: - input_tensors.append(infer_request.get_tensor(input)) - - # 6. Prepare outputs - output_tensors = [] - for output in compiled_model.outputs: - output_tensors.append(infer_request.get_tensor(output)) - - # 7. Initialize memory state before starting - infer_request.reset_state() - - #! [ov:part1] - # input data - input_data = np.arange(start=1, stop=7, dtype=np.float32) - log.info("Infer the first utterance") - for next_input in range(int(len(input_data)/2)): - infer_request.infer({"data" : np.asarray([input_data[next_input]]).reshape([1,1])}) - # check states - states = infer_request.query_state() - if len(states) == 0: - log.error("Queried states are empty") - return -1 - mstate = states[0].state - if not mstate: - log.error("Can't cast state to MemoryBlob") - return -1 - state_buf = mstate.data - log.info(state_buf[0]) - - log.info("\nReset state between utterances...\n") - infer_request.reset_state() - - log.info("Infer the second utterance") - for next_input in range(int(len(input_data)/2), len(input_data)): - infer_request.infer({0 : np.asarray([input_data[next_input]]).reshape([1,1])}) - # check states - states = infer_request.query_state() - mstate = states[0].state - state_buf = mstate.data - log.info(state_buf[0]) - #! [ov:part1] - - log.info("Execution successful") - - return 0 diff --git a/docs/snippets/src/main.c b/docs/snippets/src/main.c index 0672c3973c2..712f9a20294 100644 --- a/docs/snippets/src/main.c +++ b/docs/snippets/src/main.c @@ -106,7 +106,7 @@ project/ └── src/ - source folder └── main.c build/ - build directory - ... + ... //! [part7] -*/ +*/ \ No newline at end of file diff --git a/docs/snippets/utils.py b/docs/snippets/utils.py deleted file mode 100644 index d7572790cac..00000000000 --- a/docs/snippets/utils.py +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright (C) 2018-2024 Intel Corporation -# SPDX-License-Identifier: Apache-2.0 -# - -import tempfile -import numpy as np -from sys import platform - -import openvino as ov -import openvino.runtime.opset12 as ops - - -def get_dynamic_model(): - param = ops.parameter(ov.PartialShape([-1, -1]), name="input") - return ov.Model(ops.relu(param), [param]) - - -def get_model(input_shape = None, input_dtype=np.float32) -> ov.Model: - if input_shape is None: - input_shape = [1, 3, 32, 32] - param = ops.parameter(input_shape, input_dtype, name="input") - relu = ops.relu(param, name="relu") - relu.output(0).get_tensor().set_names({"result"}) - model = ov.Model([relu], [param], "test_model") - - assert model is not None - return model - - -def get_advanced_model(): - data = ops.parameter(ov.Shape([1, 3, 64, 64]), ov.Type.f32, name="input") - data1 = ops.parameter(ov.Shape([1, 3, 64, 64]), ov.Type.f32, name="input2") - axis_const = ops.constant(1, dtype=ov.Type.i64) - split = ops.split(data, axis_const, 3) - relu = ops.relu(split.output(1)) - relu.output(0).get_tensor().set_names({"result"}) - return ov.Model([split.output(0), relu.output(0), split.output(2)], [data, data1], "model") - - -def get_image(shape = (1, 3, 32, 32), dtype = "float32"): - np.random.seed(42) - return np.random.rand(*shape).astype(dtype) - - -def get_path_to_extension_library(): - library_path="" - if platform == "win32": - library_path="openvino_template_extension.dll" - else: - library_path="libopenvino_template_extension.so" - return library_path - - -def get_path_to_model(input_shape = None): - if input_shape is None: - input_shape = [1, 3, 32, 32] - path_to_xml = tempfile.NamedTemporaryFile(suffix="_model.xml").name - model = get_model(input_shape) - ov.serialize(model, path_to_xml) - return path_to_xml - - -def get_temp_dir(): - temp_dir = tempfile.TemporaryDirectory() - return temp_dir