Skip to content

Commit f97813e

Browse files
Fixing reference to docs (#3937)
1 parent ca7e206 commit f97813e

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

demos/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,9 @@ python -mpip install --user -r <omz_dir>/demos/requirements.txt
289289
290290
### <a name="python_model_api"></a>Python\* model API package
291291
292-
Python* ModelAPI is factored out as a sepparate package. Refer to the [Python Model API documentation](common/python/model_zoo/model_api/README.md#installing-python-model-api-package) to learn about its installation. At the same time demos can find this package on their own. It's not required to install ModelAPI for demos.
292+
Python* ModelAPI is factored out as a separate package. Refer to the
293+
[Python Model API documentation](common/python/model_zoo/model_api/README.md#installing-python-model-api-package)
294+
to learn about its installation. At the same time demos can find this package on their own. It's not required to install ModelAPI for demos.
293295
294296
### <a name="build_python_extensions"></a>Build the Native Python\* Extension Modules
295297

tools/accuracy_checker/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ Use `-h, --help` to get the full list of command-line options. Some arguments ar
161161
- `--shuffle` allows shuffle annotation during creation a subset if subsample_size argument is provided. Default is `True`.
162162
- `--intermediate_metrics_results` enables intermediate metrics results printing. Default is `False`
163163
- `--metrics_interval` number of iterations for updated metrics result printing if `--intermediate_metrics_results` flag enabled. Default is 1000.
164-
- `--sub_evaluation` enables evaluation of subset of dataset with predefined `subset_metrics`. Default is `False`. See [Sub evaluation with subset metrics](#Sub-evaluation-with-subset-metrics)
164+
- `--sub_evaluation` enables evaluation of subset of dataset with predefined `subset_metrics`. Default is `False`.
165+
See [Sub evaluation with subset metrics](#sub-evaluation-with-subset-metrics)
165166

166167
You are also able to replace some command-line arguments with the environment variables for path prefixing. Supported list of variables includes:
167168
* `DEFINITIONS_FILE` - equivalent of `-d`, `-definitions`.
@@ -264,7 +265,7 @@ or use existing annotation file and dataset meta:
264265
- `dataset_meta` - path to metadata file (generated by converter).
265266
More detailed information about annotation conversion you can find in [Annotation Conversion Guide](accuracy_checker/annotation_converters/README.md).
266267

267-
- `subset_metrics` - list of dataset subsets with uniqe size and metrics, computed if `--sub_evaluation` flag enabled. If `subsample_size` is defined then only subset with matching `subset_size` is evaluated, otherwise by default the first subset is validated. See [Sub evaluation with subset metrics](#Sub-evaluation-with-subset-metrics).
268+
- `subset_metrics` - list of dataset subsets with uniqe size and metrics, computed if `--sub_evaluation` flag enabled. If `subsample_size` is defined then only subset with matching `subset_size` is evaluated, otherwise by default the first subset is validated. See [Sub evaluation with subset metrics](#sub-evaluation-with-subset-metrics).
268269
- `subset_size` - size of dataset subset to evaluate, its value is compared with `subsample_size` to select desired subset for evaluation.
269270
- `metrics` - list of metrics specific for defined subset size
270271

tools/accuracy_checker/accuracy_checker/launcher/openvino_launcher_readme.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
OpenVINO™ launcher is one of the supported wrappers for easily launching models within Accuracy Checker tool. This launcher uses OpenVINO™ with support API 2.0 as inference backend and accepts for executing networks in OpenVINO™ supported formats.
44

5-
**Note**: the tool by default executes OpenVINO™ with API2.0 if it is available. In order to run model with API1.0 you need specify `--use_new_api False` parametrs, see [this section](#deprecated-how-to-configure-openvino-api-10-launcher) for details how to setup Accuracy Cheker launcher for API 1.0 and [migration instruction](#migrate-accuracy-checker-configuration-from-openvino-api-10-to-20) for configs.
5+
**Note**: the tool by default executes OpenVINO™ with API2.0 if it is available. In order to run model with API1.0 you need specify `--use_new_api False` parametrs, see [this section](#deprecated-how-to-configure-openvino-api-10-launcher) for details how to setup Accuracy Checker launcher for API 1.0 and
6+
[migration instruction](#migrate-accuracy-checker-configuration-from-openvino-api-1-0-to-2-0) for configs.
67

78
For enabling OpenVINO™ launcher you need to add `framework: openvino` in launchers section of your configuration file and provide following parameters:
89

tools/accuracy_checker/configs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How to use predefined configuration files
22

3-
**Note**: Since 2022.1 all provided Open Model Zoo configuration files switched to work with OpenVINO™ API 2.0. For launching models with API 1.0, additional actions may be required, see [config migration guide](../accuracy_checker/launcher/openvino_launcher_readme.md#migrate-accuracy-checker-configuration-from-openvino-api-10-to-20).
3+
**Note**: Since 2022.1 all provided Open Model Zoo configuration files switched to work with OpenVINO™ API 2.0. For launching models with API 1.0, additional actions may be required, see [config migration guide](../accuracy_checker/launcher/openvino_launcher_readme.md#migrate-accuracy-checker-configuration-from-openvino-api-1-0-to-2-0).
44

55

66
## Structure

0 commit comments

Comments
 (0)