From 4fbfb505e6974672a2569c26e4c597405b974278 Mon Sep 17 00:00:00 2001 From: Adrian Tobiszewski Date: Thu, 23 Jul 2026 08:53:48 +0200 Subject: [PATCH] Fix broken links in docs and demos --- demos/README.md | 17 ----------------- demos/image_classification/README.md | 5 ----- .../real_time_stream_analysis/python/README.md | 1 - docs/dag_scheduler.md | 12 ------------ docs/demultiplexing.md | 1 - docs/dynamic_input.md | 3 --- docs/shape_batch_size_and_layout.md | 2 +- src/custom_nodes/east_ocr/README.md | 1 - src/custom_nodes/face_blur/README.md | 1 - src/custom_nodes/horizontal_ocr/README.md | 2 -- .../model_zoo_intel_object_detection/README.md | 1 - 11 files changed, 1 insertion(+), 45 deletions(-) diff --git a/demos/README.md b/demos/README.md index c8a808fa1c..dc5cd75f33 100644 --- a/demos/README.md +++ b/demos/README.md @@ -15,13 +15,8 @@ ovms_demos_continuous_batching_vlm ovms_demos_image_generation ovms_demo_clip_image_classification ovms_demo_age_gender_guide -ovms_demo_horizontal_text_detection -ovms_demo_optical_character_recognition ovms_demo_face_detection -ovms_demo_face_blur_pipeline ovms_demo_capi_inference_demo -ovms_demo_single_face_analysis_pipeline -ovms_demo_multi_faces_analysis_pipeline ovms_docs_demo_ensemble ovms_docs_demo_mediapipe_image_classification ovms_docs_demo_mediapipe_multi_model @@ -32,7 +27,6 @@ ovms_docs_image_classification ovms_demo_using_onnx_model ovms_demo_tf_classification ovms_demo_person_vehicle_bike_detection -ovms_demo_vehicle_analysis_pipeline ovms_demo_real_time_stream_analysis ovms_demo_using_paddlepaddle_model ovms_demo_bert @@ -92,17 +86,6 @@ Check out the list below to see complete step-by-step examples of using OpenVINO |[Iris demo](./mediapipe/object_detection/README.md)| A pipeline implementing iris detection | |[Holistic demo](./mediapipe/holistic_tracking/README.md)| A complex pipeline linking several image analytical models and image transformations | -## With DAG Pipelines -| Demo | Description | -|---|---| -|[Horizontal Text Detection in Real-Time](horizontal_text_detection/python/README.md) | Run prediction on camera stream using a horizontal text detection model via gRPC API. This demo uses [pipeline](../docs/dag_scheduler.md) with [horizontal_ocr custom node](https://github.com/openvinotoolkit/model_server/tree/main/src/custom_nodes/horizontal_ocr) and [demultiplexer](../docs/demultiplexing.md). | -|[Optical Character Recognition Pipeline](optical_character_recognition/python/README.md) | Run prediction on a JPEG image using a pipeline of text recognition and text detection models with a custom node for intermediate results processing via gRPC API. This demo uses [pipeline](../docs/dag_scheduler.md) with [east_ocr custom node](https://github.com/openvinotoolkit/model_server/tree/main/src/custom_nodes/east_ocr) and [demultiplexer](../docs/demultiplexing.md). | -|[Single Face Analysis Pipeline](single_face_analysis_pipeline/python/README.md)|Run prediction on a JPEG image using a simple pipeline of age-gender recognition and emotion recognition models via gRPC API to analyze image with a single face. This demo uses [pipeline](../docs/dag_scheduler.md) | -|[Multi Faces Analysis Pipeline](multi_faces_analysis_pipeline/python/README.md)|Run prediction on a JPEG image using a pipeline of age-gender recognition and emotion recognition models via gRPC API to extract multiple faces from the image and analyze all of them. This demo uses [pipeline](../docs/dag_scheduler.md) with [model_zoo_intel_object_detection custom node](https://github.com/openvinotoolkit/model_server/tree/main/src/custom_nodes/model_zoo_intel_object_detection) and [demultiplexer](../docs/demultiplexing.md) | -|[Model Ensemble Pipeline](model_ensemble/python/README.md)|Combine multiple image classification models into one [pipeline](../docs/dag_scheduler.md) and aggregate results to improve classification accuracy. | -|[Face Blur Pipeline](face_blur/python/README.md)|Detect faces and blur image using a pipeline of object detection models with a custom node for intermediate results processing via gRPC API. This demo uses [pipeline](../docs/dag_scheduler.md) with [face_blur custom node](https://github.com/openvinotoolkit/model_server/tree/main/src/custom_nodes/face_blur). | -|[Vehicle Analysis Pipeline](vehicle_analysis_pipeline/python/README.md)|Detect vehicles and recognize their attributes using a pipeline of vehicle detection and vehicle attributes recognition models with a custom node for intermediate results processing via gRPC API. This demo uses [pipeline](../docs/dag_scheduler.md) with [model_zoo_intel_object_detection custom node](https://github.com/openvinotoolkit/model_server/tree/main/src/custom_nodes/model_zoo_intel_object_detection). | - ## With C++ Client | Demo | Description | |---|---| diff --git a/demos/image_classification/README.md b/demos/image_classification/README.md index 92a7b04c27..05b42de9f9 100644 --- a/demos/image_classification/README.md +++ b/demos/image_classification/README.md @@ -14,8 +14,3 @@ ovms_demo_image_classification_go | Demo | Description | |---|---| |[Image Classification](python/README.md)|Run prediction on a JPEG image using image classification model via gRPC API.| - -## Go -| Demo | Description | -|---|---| -|[Image Classification](go/README.md)|Run prediction on a JPEG image using image classification model via gRPC API.| diff --git a/demos/real_time_stream_analysis/python/README.md b/demos/real_time_stream_analysis/python/README.md index 4c57021cd9..016a407725 100644 --- a/demos/real_time_stream_analysis/python/README.md +++ b/demos/real_time_stream_analysis/python/README.md @@ -185,7 +185,6 @@ The helper class `StreamClient` supports using unary gRPC calls. In that case it It sends the frames to the model server asynchronously but each of them is stateless and each request can be processed independently. The key advantage of that mode is easier load balancing and scalability, because each request could be routed to a different instance of the model server or a different compute node. -Such use case with the unary calls with a horizontal text analysis can be followed based on [this document](../../horizontal_text_detection/python/README.md). > **Note** Depending on the output format, there might be needed a custom postprocessing function implementation. diff --git a/docs/dag_scheduler.md b/docs/dag_scheduler.md index 89f5255bac..a13c14af38 100644 --- a/docs/dag_scheduler.md +++ b/docs/dag_scheduler.md @@ -21,7 +21,6 @@ This guide gives information about: * [Node Types](#node-types) * [Configuration file](#configuration-file) * [Using the pipelines](#using-pipelines) -* [Pipelines examples](#pipelines-examples) * [Current Limitations](#current-limitations) @@ -205,19 +204,8 @@ and [REST Model Ready](model_server_rest_api_kfs.md) The only difference in using the pipelines and individual models is in version management. In all calls to the pipelines, the version parameter is ignored. Pipelines are not versioned. Though, they can reference a particular version of the models in the graph. -## Pipelines Examples - -[Single face analysis with combined models](../demos/single_face_analysis_pipeline/python/README.md) - -[Multiple vehicles analysis using demultiplexer with model_zoo_object_detection example custom node](../demos/vehicle_analysis_pipeline/python/README.md) - -[Optical Character Recognition pipeline with east_ocr example custom node](../demos/optical_character_recognition/python/README.md) - -[Horizontal Text Detection pipeline with horizontal_ocr example custom node](../demos/horizontal_text_detection/python/README.md) - ## Current limitations -- Models with "auto" [batch size](dynamic_bs_auto_reload.md) or [shape](dynamic_shape_auto_reload.md) cannot be referenced in pipeline - Connected inputs and output for subsequent node models need to match each other in terms of data shape, precision and layout - there is no automatic conversion between input/output model precisions or layouts. This limitation can be addressed with `--shape` and `--layout` model configuration or with a custom node to transform the data as required to match the expected data format. - REST requests with no named format (JSON body with one unnamed input) are not supported diff --git a/docs/demultiplexing.md b/docs/demultiplexing.md index 5b09d4905c..e4c56012c5 100644 --- a/docs/demultiplexing.md +++ b/docs/demultiplexing.md @@ -176,7 +176,6 @@ Output: (N,1,1001) Because of this additional dimension, demultiplexing implementation is generic and can support any input and output data layout. -Exemplary usage of this feature is available in [dynamic batch size guide](./dynamic_bs_demultiplexer.md). *Note:* You can use additional parameters in model config ('nireq' and 'NUM_STREAMS') to fine-tune your performance for dynamic batch. 'NUM_STREAMS' allows for multiple parallel inferences processing in OpenVINO™ which may increase throughput at the cost of latency of predict requests. 'nireq' specifies how many inference requests can be prepared. diff --git a/docs/dynamic_input.md b/docs/dynamic_input.md index 18725d6207..7e34f0dcb9 100644 --- a/docs/dynamic_input.md +++ b/docs/dynamic_input.md @@ -21,13 +21,10 @@ There are multiple ways of enabling dynamic inputs depending on the kind of serv - [dynamic input shape with binary input format](./dynamic_shape_binary_inputs.md) - send data in binary format (JPEG or PNG encoded), so the Model Server will adjust the input during data decoding. Consider this option in case of slower networks to minimize amount of data transferred over the network and fit image size to the size accepted by endpoint. -- [**DEPRECATED**] [dynamic batch size with automatic model reloading](./dynamic_bs_auto_reload.md) - configure the Model Server to reload the model each time it receives a request with a batch size other than what is currently set. Consider using this option when request batch size may change, but usually stays the same. Each request with varying batch size will impact the performance due to model reloading. -- [**DEPRECATED**] [dynamic shape with automatic model reloading](./dynamic_shape_auto_reload.md) - configure the Model Server to reload the model each time the model receives a request with data in shape other than what is currently set. Consider using this option when request shape may change, but usually stays the same. Each request with varying shape will impact the performance due to model reloading. **DAG Pipelines**: -- [dynamic batch size with a demultiplexer](./dynamic_bs_demultiplexer.md) - create a simple pipeline that splits data of any batch size and performs inference on each element in the batch separately. Consider using this option if incoming requests will be containing various batch size. This option does not need to reload underlying model, therefore there is no model reloading impact on the performance. - [dynamic input shape with a custom node](./dynamic_shape_custom_node.md) - create a simple pipeline by pairing your model with a custom node that performs data preprocessing and provides the model with data in an acceptable shape. Consider this option if you want to fit the image into model shape by performing image resize operation before inference. This may affect accuracy. diff --git a/docs/shape_batch_size_and_layout.md b/docs/shape_batch_size_and_layout.md index 3ca706b839..329696f529 100644 --- a/docs/shape_batch_size_and_layout.md +++ b/docs/shape_batch_size_and_layout.md @@ -9,7 +9,7 @@ It accepts also a value `auto` - this command makes the served model set the bat This feature is useful for sequential inference requests of the same batch size. *Note:* In case of frequent batch size changes in predict requests, consider using [demultiplexing feature](./demultiplexing.md) from [Directed Acyclic Graph Scheduler](./dag_scheduler.md) which is more -performant in such situations because it is not adding an extra overhead with model reloading between requests like --batch_size auto setting. Exemplary usage of this feature can be found in [dynamic_batch_size](./dynamic_bs_demultiplexer.md) document. +performant in such situations because it is not adding an extra overhead with model reloading between requests like --batch_size auto setting. - OpenVINO™ Model Server determines the batch size based on the size of the first dimension in the first input by default. For example with the input shape (1, 3, 225, 225), the batch size is set to 1. With input shape (8, 3, 225, 225) the batch size is set to 8. diff --git a/src/custom_nodes/east_ocr/README.md b/src/custom_nodes/east_ocr/README.md index a0e9b0c5f0..35b0e84fa0 100644 --- a/src/custom_nodes/east_ocr/README.md +++ b/src/custom_nodes/east_ocr/README.md @@ -7,7 +7,6 @@ DAG pipeline. Additionally to the detected text boxes, in the two additional outputs are returned their coordinates with information about geometry and confidence levels for the filtered list of detections. -**NOTE** Exemplary [configuration file](https://github.com/openvinotoolkit/model_server/blob/main/demos/optical_character_recognition/python/config.json) is available in [optical character recognition demo](https://github.com/openvinotoolkit/model_server/blob/main/demos/optical_character_recognition/python/). # Building custom node library diff --git a/src/custom_nodes/face_blur/README.md b/src/custom_nodes/face_blur/README.md index 21afb00c5d..f42bef5e52 100644 --- a/src/custom_nodes/face_blur/README.md +++ b/src/custom_nodes/face_blur/README.md @@ -18,7 +18,6 @@ All [OpenVINO Model Zoo](https://github.com/openvinotoolkit/open_model_zoo/tree/ - vehicle-license-plate-detection - pedestrian-and-vehicle-detector -**NOTE** Exemplary [configuration file](https://github.com/openvinotoolkit/model_server/blob/main/demos/face_blur/python/config.json) is available in [face_blur demo](https://github.com/openvinotoolkit/model_server/blob/main/demos/face_blur/python/). # Building custom node library diff --git a/src/custom_nodes/horizontal_ocr/README.md b/src/custom_nodes/horizontal_ocr/README.md index 85ae4e2b95..14161e7359 100644 --- a/src/custom_nodes/horizontal_ocr/README.md +++ b/src/custom_nodes/horizontal_ocr/README.md @@ -6,9 +6,7 @@ Each image in the output will be resized to the predefined target size to fit th DAG pipeline. Additionally to the detected text boxes, in the two additional outputs are returned their coordinates and confidence levels. -This custom node can be used to process video frames via [camera example](../../../demos/horizontal_text_detection/python/README.md). -**NOTE** Exemplary [configuration file](https://github.com/openvinotoolkit/model_server/blob/main/demos/horizontal_text_detection/python/config.json) is available in [demo with camera](https://github.com/openvinotoolkit/model_server/blob/main/demos/horizontal_text_detection/python/). # Building custom node library diff --git a/src/custom_nodes/model_zoo_intel_object_detection/README.md b/src/custom_nodes/model_zoo_intel_object_detection/README.md index 556b858c15..5cebf6ed6c 100644 --- a/src/custom_nodes/model_zoo_intel_object_detection/README.md +++ b/src/custom_nodes/model_zoo_intel_object_detection/README.md @@ -25,7 +25,6 @@ All [OpenVINO Model Zoo](https://github.com/openvinotoolkit/open_model_zoo/tree/ Public [OpenVINO Model Zoo](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public) object detection models with output tensor shape: `[1, 1, 100, 7]`: - ssdlite_mobilenet_v2 -**NOTE** Exemplary configuration files are available in [vehicle analysis pipeline demo](https://github.com/openvinotoolkit/model_server/blob/main/demos/horizontal_text_detection/python/config.json) and [multiple faces analysis demo](https://github.com/openvinotoolkit/model_server/blob/main/demos/multi_faces_analysis_pipeline/python/config.json). # Building custom node library