Skip to content

Commit f7ac54c

Browse files
authoredFeb 17, 2024
[DOCS] Remove some api 1.0 names and mentions from dev docs (openvinotoolkit#22873)
### Details: - Remove some api 1.0 names and mentions from dev docs ### Tickets: - CVS-132237
1 parent 099c6f6 commit f7ac54c

File tree

8 files changed

+27
-29
lines changed

8 files changed

+27
-29
lines changed
 

‎src/bindings/c/docs/api_overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Overview of OpenVINO C* API 2.0
1+
# Overview of OpenVINO C* API
22

33
This API provides a simplified interface for OpenVINO functionality that allows to:
44

‎src/core/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ People from the [openvino-ngraph-maintainers](https://github.com/orgs/openvinoto
1515
## Components
1616

1717
OpenVINO Core has the next structure:
18-
* [builders](./builder) is obsolete component which provides helper methods for operation creations. Please don't use this API, and use public OpenVINO API instead.
1918
* [dev_api](./dev_api) contains developer API. In order to use this API, you need to link your component against `openvino::runtime::dev`.
2019
* [docs](./docs) contains developer documentation pages for the component.
2120
* [include](./include) contains public API. Detailed information about provided API can be found [here](./docs/api_details.md).

‎src/core/docs/api_details.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ OpenVINO Core API contains two folders:
66
## Structure of Core API
77
<pre>
88
<code>
9-
<a href="../include/openvino">openvino/</a> // Common folder with OpenVINO 2.0 API
10-
<a href="../include/openvino/core/">core/</a> // Contains common classes which are responsible for model representation
11-
<a href="../include/openvino/op/">op/</a> // Contains all supported OpenVINO operations
12-
<a href="../include/openvino/opsets/">opsets/</a> // Contains definitions of each official OpenVINO opset
13-
<a href="../include/openvino/pass/">pass/</a> // Defines classes for developing transformation and several common transformations
14-
<a href="../include/openvino/runtime/">runtime/</a> // Contains OpenVINO tensor definition
9+
<a href="../include/openvino">openvino/</a> // Common folder with OpenVINO API
10+
<a href="../include/openvino/core/">core/</a> // Contains common classes which are responsible for model representation
11+
<a href="../include/openvino/op/">op/</a> // Contains all supported OpenVINO operations
12+
<a href="../include/openvino/opsets/">opsets/</a> // Contains definitions of each official OpenVINO opset
13+
<a href="../include/openvino/pass/">pass/</a> // Defines classes for developing transformation and several common transformations
14+
<a href="../include/openvino/runtime/">runtime/</a> // Contains OpenVINO tensor definition
1515
</code>
1616
</pre>
1717

‎src/core/docs/operation_enabling_flow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
2. Add operation to the dedicated opset file `src/core/include/openvino/opsets/opsetX_tbl.hpp`
1919

20-
3. Implement `evaluate` method for the operation (reference implementation) in the `openvino/core/reference/[src|include]/ngraph/runtime/reference/`. Reference implementation can be called from Template plugin or from OpenVINO (`src/core/src/op/your_operation_name.cpp/hpp`).
20+
3. Implement `evaluate` method for the operation (reference implementation) in the `openvino/core/[src|include/openvino]/op/`. Reference implementation can be called from Template plugin or from OpenVINO.
2121
To not increase the binary size of openvino lib it should be placed in Template plugin unless you are directly asked to put it in the OpenVINO core. While adding reference implementation the following points should be considered:
2222
* The method should avoid using the template parameters if possible. However, for the small operations like activation functions it is acceptable.
2323
* The method should be instantiated for practical data types only.

‎src/core/docs/tests.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
OpenVINO Core is covered by tests from the binary `ov_core_unit_tests`. This binary can be built by the target with the same name.
44

5-
OpenVINO Core [tests](../tests/) have next structure:
5+
OpenVINO Core [tests](../tests/) consists of common and op evaluation tests. Folder have next structure:
66
* `conditional_compilation` - tests cover conditional compilation feature
7-
* `frontend` - PaddlePaddle frontend tests (should be removed in the nearest future)
7+
* `frontend` - common frontend tests
88
* `models` - test models
9-
* `op_eval` - tests cover evaluate methods
109
* `pass` - tests covers common transformations
1110
* `type_prop` - type and shape propagation tests
1211
* `visitors` - tests covers visitor API for all supported operations

‎src/frontends/onnx/docs/tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ git clone --branch rel-1.8.1 --single-branch --recursive https://github.com/micr
115115
```
116116
- (Optional) To build ONNX Runtime with a non-release OpenVINO version, an additional step is required for the `rel-1.8.1` version:
117117
```
118-
cd <OV_INSTALL_DIR>/deployment_tools/inference_engine && touch version.txt && echo "2021.4" > version.txt
118+
cd <OV_INSTALL_DIR>/deployment_tools/openvino && touch version.txt && echo "2021.4" > version.txt
119119
```
120120
2. Set up the OpenVINO environment:
121121
```

‎src/inference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ OpenVINO Inference has the following structure:
1616
* [include](./include) contains public API. Find more information in the [OpenVINO Inference API](./docs/api_details.md) document.
1717
* [src](./src) contains sources of the component.
1818

19-
OpenVINO Inference has unit and functional tests. Unit tests are located in [src/tests/unit/inference_engine](../tests/unit/inference_engine/), functional tests are located in [src/tests/functional/inference_engine](../tests/functional/inference_engine/).
19+
OpenVINO Inference has unit and functional tests. Unit tests are located in [src/inference/tests/unit](tests/unit/), functional tests are located in [src/inference/tests/functional](tests/unit/).
2020

2121
## See also
2222

‎src/tests/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,42 @@ This is OpenVINO testing framework. OpenVINO test system contains:
99
* Unit test folder for a particular module should replicate `SRC` folder layout of the corresponding tested module to
1010
allow further developers get better understanding which part of software is already covered by unit tests and where
1111
to add new tests if needed.
12-
> **Example**: There are `network_serializer.h` and `network_serializer.cpp` files within the `src` folder of the
13-
tested OpenVINO module. Then, a new `network_serializer_test.cpp` file should be created within the root of
12+
> **Example**: There are `compiled_model.hpp` and `compiled_model.cpp` files within the `src` folder of the
13+
tested OpenVINO module. Then, a new `compiled_model_test.cpp` file should be created within the root of
1414
the Unit Test folder for this module. This test file should cover all the classes and methods from the original
1515
files.
1616

17-
> **Example**: There is the `ie_reshaper.cpp` file within the `src/shape_infer` subfolder of the tested module. In this case,
17+
> **Example**: There is the `reshape.cpp` file within the `src/shape_infer` subfolder of the tested module. In this case,
1818
a new `shape_infer` subfolder should be created within the root of the Unit Test folder for this module. And a new
19-
`ie_reshaper_test.cpp` file should be created within this newly created subfolder. This test file should cover all
19+
`reshape_test.cpp` file should be created within this newly created subfolder. This test file should cover all
2020
the classes and methods from the original file.
2121

2222
* Each Unit Test should cover only the target classes and methods. If needed, all external interface components should
2323
be mocked. There are common mock objects provided within the common Unit Test Utilities to stub the general
2424
OpenVINO API classes.
25-
> **Example**: There are `cnn_network_impl.hpp` and `cnn_network_impl.cpp` files within the `src` folder of the tested
26-
module. In this case, a new `cnn_network_impl_test.cpp` file should be created and it should contain tests on
27-
`CNNNetworkImpl` class only.
25+
> **Example**: There are `iplugin.hpp` and `iplugin.cpp` files within the `src` folder of the tested
26+
module. In this case, a new `iplugin_test.cpp` file should be created and it should contain tests on
27+
`IPlugin` class only.
2828

2929
* It is not prohibited to have several test files for the same file from the tested module.
3030
* It is not prohibited to create a separate test file for specific classes or functions (not for the whole file).
3131

3232
* **Functional tests**
3333
This test type is used to verify public OpenVINO API. There are following types of functional tests:
34-
* `inference_engine_tests` are plugin-independent tests. They are used to verify OpenVINO API methods that do not
35-
involve any plugin runtime. The examples are: `network_reader`, `network_serializer`, and `precision` tests.
34+
* `openvino_tests` are plugin-independent tests. They are used to verify OpenVINO API methods that do not
35+
involve any plugin runtime. The examples are: `model_reader`, `model_serializer`, and `type` tests.
3636
* `plugin_tests` are plugin-dependent tests. These tests require plugin runtime to be executed during testing. For example,
37-
any tests using `ExecutableNetwork`, `InferRequest` API can only be implemented within this test group.
37+
any tests using `CompiledModel`, `InferRequest` API can only be implemented within this test group.
3838

39-
> **Example**: Any new test on creating a CNNNetwork object and checking its output info should be included to
40-
the OpenVINO Functional tests suite. However, any new test containing reading of a network and loading it to a
39+
> **Example**: Any new test on creating a ov::Model object and checking its output info should be included to
40+
the OpenVINO Functional tests suite. However, any new test containing reading of a model and loading it to a
4141
specified plugin is always the plugin test.
4242

4343
There are following rules which are **required** for Functional Tests development:
4444
* All Functional tests are separated into different executables for the OpenVINO and each plugin.
4545
* Pre-converted IR files must not be used within the new Functional Tests. Tested models should be generated during
46-
the tests execution. The main method to generate a required model is building of the required NGraph function and
47-
creating a CNNNetwork using it. If a required layer is not covered by Ngraph, it is allowed to build IR file using
46+
the tests execution. The main method to generate a required model is building of the required OpenVINO model.
47+
If a required layer is not covered by OpenVINO, it is allowed to build IR file using
4848
`xml_net_builder` utility (refer to the `ir_net.hpp` file). IR XML files hardcoded as strings within the test
4949
code should not be used.
5050
* All the plugin test cases are parameterized with (at least) the device name and included to the common
@@ -63,7 +63,7 @@ This is OpenVINO testing framework. OpenVINO test system contains:
6363

6464
* **OpenVINO tests utilities**
6565
The set of utilities which are used by the OpenVINO Functional and Unit tests. Different helper functions,
66-
blob comparators, OS-specific constants, etc. are implemented within the utilities.
66+
tensor comparators, OS-specific constants, etc. are implemented within the utilities.
6767
Internal namespaces (for example, `ov::test::utils::`) must be used to
6868
separate utilities by domains.
6969

0 commit comments

Comments
 (0)