Align folder structure for Benchmark Tool (#6625)

* openvino namespace for benchmark tool

* change readme wording

* remove duplicated  README.md
This commit is contained in:
Sergey Lyubimtsev 2021-07-19 11:57:51 +03:00 committed by GitHub
parent 4373b0cb7d
commit 6e14890972
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 23 additions and 24 deletions

6
tools/.gitignore vendored
View File

@ -1,2 +1,6 @@
openvino.tools.benchmark.log
*.log
*.egg-info/
*.egg
__pycache__/
build/
dist/

View File

@ -23,7 +23,7 @@ if(ENABLE_PYTHON)
# creates a copy inside bin directory for developers to have ability running python benchmark_app
add_custom_target(${TARGET_NAME} ALL
COMMAND ${CMAKE_COMMAND} -E make_directory ${PYTHON_BRIDGE_OUTPUT_DIRECTORY}/tools
COMMAND ${CMAKE_COMMAND} -E copy_directory ${OpenVINO_SOURCE_DIR}/tools/benchmark ${PYTHON_BRIDGE_OUTPUT_DIRECTORY}/tools/benchmark
COMMAND ${CMAKE_COMMAND} -E copy_directory ${OpenVINO_SOURCE_DIR}/tools/benchmark_tool/openvino/tools/benchmark ${PYTHON_BRIDGE_OUTPUT_DIRECTORY}/tools/benchmark
)
ie_cpack_add_component(python_tools_${PYTHON_VERSION})
@ -37,14 +37,10 @@ if(ENABLE_PYTHON)
DESTINATION deployment_tools/tools
COMPONENT python_tools)
install(FILES README.md
DESTINATION python/${PYTHON_VERSION}/openvino/tools
COMPONENT python_tools_${PYTHON_VERSION})
install(DIRECTORY benchmark
install(DIRECTORY benchmark_tool/openvino/tools/benchmark
DESTINATION python/${PYTHON_VERSION}/openvino/tools
USE_SOURCE_PERMISSIONS
COMPONENT python_tools_${PYTHON_VERSION})
ie_cpack(python_tools python_tools_${PYTHON_VERSION})
endif()

View File

@ -1,13 +1,12 @@
# OpenVINO™ Python* openvino.tools package
# OpenVINO™ Python* development tools
## General
`openvino.tools` package includes:
OpenVINO includes following tools:
* openvino.tools.benchmark
Please, refer to https://docs.openvinotoolkit.org for details.
## Installation
Choose necessary Python\* version and define `PYTHONPATH` environment variable.
### Prerequisites
@ -15,11 +14,12 @@ Install prerequisites first:
#### 1. Python
**openvino.tools** is **Python 3** library. Install it first:
Install **Python** prerequisites:
- [Python3][python3]
- [setuptools][setuptools]
Run following command to install these prerequisites on Ubuntu*:
```bash
sudo apt-get install python3 python3-dev python3-setuptools python3-pip
```
@ -49,13 +49,17 @@ Virtual environment can be deactivated using command
deactivate
```
#### 2. Install package prerequisites
#### 2. Install packages
The next step is installing package prerequisites.
You can install tools by specifying path to tool with `setup.py` in `pip install` command:
```bash
python3 -m pip install -r benchmark/requirements.txt
python3 -m pip install <tools_folder>/
```
For example, to install Benchmark Tool, use the following command:
```bash
python3 -m pip install benchmark_tool/
```
### Configuration

View File

@ -10,18 +10,15 @@ $ python setup.py sdist bdist_wheel
"""
from setuptools import setup, find_packages
with open('README.md', 'r', encoding='utf-8') as f:
with open('openvino/tools/benchmark/README.md', 'r', encoding='utf-8') as f:
long_description = f.read()
with open('benchmark/requirements.txt') as f:
with open('openvino/tools/benchmark/requirements.txt') as f:
required = f.read().splitlines()
required.extend(['openvino'])
pkgs = find_packages()
NAMESPACE = 'openvino.tools'
setup(
name='openvino-tools',
name='benchmark_tool',
version='0.0.0',
author='Intel® Corporation',
license='OSI Approved :: Apache Software License',
@ -39,9 +36,7 @@ setup(
'OSI Approved :: Apache Software License',
'Operating System :: OS Independent',
],
package_dir={''.join((NAMESPACE, '.', pkg)) : pkg.replace('.', '/')
for pkg in pkgs},
packages=[''.join((NAMESPACE, '.', pkg)) for pkg in pkgs],
packages=find_packages(),
install_requires=required,
python_requires='>=3.6',
)