Skip to content

Commit 153ac5d

Browse files
Update references to docs (#3941)
1 parent f97813e commit 153ac5d

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

demos/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ For the open-source version of OpenVINO, set the following variables:
177177
Alternatively, these values can be provided via command line while running `cmake`. See [CMake search procedure](https://cmake.org/cmake/help/latest/command/find_package.html#search-procedure).
178178
Also add paths to the built OpenVINO™ Runtime libraries to the `LD_LIBRARY_PATH` (Linux) or `PATH` (Windows) variable before building the demos.
179179
180-
### <a name="build_demos_linux"></a>Build the Demo Applications on Linux*
180+
### Build the Demo Applications on Linux*
181181
182182
The officially supported Linux* build environment is the following:
183183
@@ -220,7 +220,7 @@ cmake --build .
220220
For the release configuration, the demo application binaries are in `<path_to_build_directory>/intel64/Release/`;
221221
for the debug configuration — in `<path_to_build_directory>/intel64/Debug/`.
222222
223-
### <a name="build_demos_windows"></a>Build the Demos Applications on Microsoft Windows* OS
223+
### Build the Demos Applications on Microsoft Windows* OS
224224
225225
The recommended Windows* build environment is the following:
226226
@@ -279,21 +279,21 @@ cmake -A x64 <open_model_zoo>/demos
279279
cmake --build . --config Debug
280280
```
281281
282-
### <a name="python_requirements"></a>Dependencies for Python* Demos
282+
### Dependencies for Python* Demos
283283
284284
The dependencies for Python demos must be installed before running. It can be achieved with the following command:
285285
286286
```sh
287287
python -mpip install --user -r <omz_dir>/demos/requirements.txt
288288
```
289289
290-
### <a name="python_model_api"></a>Python\* model API package
290+
### Python\* model API package
291291
292292
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)
293+
[Python Model API documentation](./common/python/model_zoo/model_api/README.md#installing-python-model-api-package)
294294
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.
295295
296-
### <a name="build_python_extensions"></a>Build the Native Python\* Extension Modules
296+
###Build the Native Python\* Extension Modules
297297
298298
Some of the Python demo applications require native Python extension modules to be built before they can be run.
299299
This requires you to have Python development files (headers and import libraries) installed.
@@ -307,7 +307,7 @@ cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_PYTHON=ON <open_model_zoo>/demos
307307
308308
Once the modules are built, add the demo build folder to the `PYTHONPATH` environment variable.
309309
310-
### <a name="build_specific_demos"></a>Build Specific Demos
310+
### Build Specific Demos
311311
312312
To build specific demos, follow the instructions for building the demo applications above,
313313
but add `--target <demo1> <demo2> ...` to the `cmake --build` command or `--target="<demo1> <demo2> ..."` to the `build_demos*` command.

tools/accuracy_checker/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,10 @@ or use existing annotation file and dataset meta:
265265
- `dataset_meta` - path to metadata file (generated by converter).
266266
More detailed information about annotation conversion you can find in [Annotation Conversion Guide](accuracy_checker/annotation_converters/README.md).
267267

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).
268+
- `subset_metrics` - list of dataset subsets with unique size and metrics, computed if `--sub_evaluation`
269+
flag enabled. If `subsample_size` is defined then only subset with matching `subset_size` is evaluated,
270+
otherwise by default the first subset is validated.
271+
See [Sub evaluation with subset metrics](#sub-evaluation-with-subset-metrics).
269272
- `subset_size` - size of dataset subset to evaluate, its value is compared with `subsample_size` to select desired subset for evaluation.
270273
- `metrics` - list of metrics specific for defined subset size
271274

@@ -321,7 +324,7 @@ metrics:
321324
threshold: 0.005
322325
```
323326

324-
#### Sub-evaluation with subset metrics
327+
### Sub-evaluation with subset metrics
325328

326329
You may optionally enable `sub_evaluation` flag to quickly get results for subset of big dataset.
327330
The `subset_metrics` needs to provide subsets with different `subset_size` and `metrics`.

tools/accuracy_checker/accuracy_checker/annotation_converters/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,7 @@ The main difference between this converter and `super_resolution` in data organi
864864
* `parti_prompts` - convert [PartiPrompts](https://github.com/google-research/parti) for text to image generation benchmarking to `Text2ImageGenerationAnnotation`.
865865
* `annotation_file` - path to annotation file in csv format.
866866

867-
## <a name="customizing-dataset-meta"></a>Customizing Dataset Meta
867+
## Customizing Dataset Meta
868868
There are situations when we need to customize some default dataset parameters (e.g. replace original dataset label map with own.)
869869
You are able to overload parameters such as `label_map`, `segmentation_colors`, `background_label` using `dataset_meta_file` argument.
870870
Dataset meta file is JSON file, which can contain the following parameters:

0 commit comments

Comments
 (0)