model_tools: update telemetry data (#3424)

* update precision setting for downloader

* update telemetry

* update version

Author: Julia Kamelina

tools/model_tools/setup.py

@@ -27,6 +27,7 @@
 import distutils.command.sdist
 import itertools
 import os
+import re
 import shutil
 from pathlib import Path
 
@@ -47,6 +48,14 @@
 def read_text(path):
     return (SETUP_DIR / path).read_text()
 
+def get_version(path):
+    version_file = read_text(path)
+    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
+    if version_match:
+        return version_match.group(1)
+    else:
+        return "0.0.0"
+
 # We can't build sdists, because we depend on files outside the
 # project directory. Disable the sdist command to prevent creation
 # of broken sdists.
@@ -98,7 +107,7 @@ def run(self):
 
 setup(
     install_requires=read_text('requirements.in'),
-    version="1.0.1",
+    version=get_version('src/openvino/model_zoo/__init__.py'),
     extras_require={
         'pytorch': read_text('requirements-pytorch.in'),
         'tensorflow2': read_text('requirements-tensorflow.in'),

tools/model_tools/src/openvino/model_zoo/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (c) 2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "1.0.2"

tools/model_tools/src/openvino/model_zoo/_common.py

@@ -20,17 +20,17 @@
 
 from pathlib import Path
 
+from . import __version__
+
 PACKAGE_DIR = Path(__file__).resolve().parent
 MODEL_ROOT = PACKAGE_DIR / 'models'
 DATASET_DEFINITIONS = PACKAGE_DIR / 'data/dataset_definitions.yml'
-VERSION_FILE = None
 
 if not MODEL_ROOT.exists() or not DATASET_DEFINITIONS.exists():
     # We are run directly from OMZ rather than from an installed environment.
     _OMZ_ROOT = PACKAGE_DIR.parents[4]
     MODEL_ROOT = _OMZ_ROOT / 'models'
     DATASET_DEFINITIONS = _OMZ_ROOT / 'data/dataset_definitions.yml'
-    VERSION_FILE = _OMZ_ROOT / 'version.txt'
 
 # make sure to update the documentation if you modify these
 KNOWN_FRAMEWORKS = {
@@ -135,25 +135,30 @@ def get_package_path(python_executable, package_name):
     return file_path.parent, completed_process.stderr
 
 def get_version():
-    if VERSION_FILE and VERSION_FILE.is_file():
-        with VERSION_FILE.open('r') as version_file:
-            version = version_file.readline().rstrip('\n')
-        return f'commit {version}'
-    else:
-        return 'unknown'
+    try:
+        from openvino.runtime import get_version as ov_get_version
+        ov_version = ov_get_version()
+        version_match = re.match(r"^([0-9]+).([0-9]+)*", ov_version)
+        return f"{version_match.group(0)}-{__version__}"
+    except BaseException:
+        return __version__
 
 @contextlib.contextmanager
 def telemetry_session(app_name, tool):
     version = get_version()
     telemetry = Telemetry(tid='UA-17808594-29', app_name=app_name, app_version=version)
     telemetry.start_session('md')
+    telemetry.send_event('md', 'version', version)
     try:
         yield telemetry
     except SystemExit as e:
         telemetry.send_event('md', f'{tool}_result', 'failure' if e.code else 'success')
+        if e.code:
+            telemetry.send_event('md', f'{tool}_error_type', type(e))
         raise
-    except BaseException:
+    except BaseException as e:
         telemetry.send_event('md', f'{tool}_result', 'exception')
+        telemetry.send_event('md', f'{tool}_error_type', type(e))
         raise
     else:
         telemetry.send_event('md', f'{tool}_result', 'success')

tools/model_tools/src/openvino/model_zoo/download_engine/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

tools/model_tools/src/openvino/model_zoo/download_engine/downloader.py

@@ -63,17 +63,12 @@ def requested_precisions(self) -> Set[str]:
         return self._requested_precisions
 
     @requested_precisions.setter
-    def requested_precisions(self, value: str = None):
-        if value is None:
-            _requested_precisions = _common.KNOWN_PRECISIONS
-        else:
-            _requested_precisions = set(value.split(','))
-
-        unknown_precisions = _requested_precisions - _common.KNOWN_PRECISIONS
+    def requested_precisions(self, value: Set[str] = None):
+        unknown_precisions = value - _common.KNOWN_PRECISIONS
         if unknown_precisions:
             sys.exit('Unknown precisions specified: {}.'.format(', '.join(sorted(unknown_precisions))))
 
-        self._requested_precisions = _requested_precisions
+        self._requested_precisions = value
 
     def _process_download(self, reporter, chunk_iterable, size, progress, file):
         start_time = time.monotonic()

tools/model_tools/src/openvino/model_zoo/omz_converter.py

@@ -196,11 +196,15 @@ def main():
     args = parser.parse_args()
 
     with _common.telemetry_session('Model Converter', 'converter') as telemetry:
-        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
+        args_count = sum([args.all, args.name is not None, args.list is not None, args.print_all])
+        if args_count == 0:
+            telemetry.send_event('md', 'converter_selection_mode', None)
+        else:
+            for mode in ['all', 'list', 'name', 'print_all']:
+                if getattr(args, mode):
+                    telemetry.send_event('md', 'converter_selection_mode', mode)
 
-        for mode in ['all', 'list', 'name']:
-            if getattr(args, mode):
-                telemetry.send_event('md', 'converter_selection_mode', mode)
+        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
 
         if args.precisions is None:
             requested_precisions = _common.KNOWN_PRECISIONS
@@ -212,7 +216,7 @@ def main():
             model_information = {
                 'name': model.name,
                 'framework': model.framework,
-                'precisions': str(precisions_to_send).replace(',', ';'),
+                'precisions': str(sorted(precisions_to_send)).replace(',', ';'),
             }
             telemetry.send_event('md', 'converter_model', json.dumps(model_information))
 

tools/model_tools/src/openvino/model_zoo/omz_downloader.py

@@ -68,25 +68,33 @@ def main():
     reporter = Downloader.make_reporter(args.progress_format)
 
     with _common.telemetry_session('Model Downloader', 'downloader') as telemetry:
-        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
-
-        for mode in ['all', 'list', 'name']:
-            if getattr(args, mode):
-                telemetry.send_event('md', 'downloader_selection_mode', mode)
+        args_count = sum([args.all, args.name is not None, args.list is not None, args.print_all])
+        if args_count == 0:
+            telemetry.send_event('md', 'downloader_selection_mode', None)
+        else:
+            for mode in ['all', 'list', 'name', 'print_all']:
+                if getattr(args, mode):
+                    telemetry.send_event('md', 'downloader_selection_mode', mode)
 
+        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
         failed_models = set()
 
-        downloader = Downloader(args.precisions, args.output_dir, args.cache_dir, args.num_attempts)
+        if args.precisions is None:
+            requested_precisions = _common.KNOWN_PRECISIONS
+        else:
+            requested_precisions = set(args.precisions.split(','))
 
         for model in models:
-            precisions_to_send = downloader.requested_precisions if args.precisions else downloader.requested_precisions & model.precisions
+            precisions_to_send = requested_precisions if args.precisions else requested_precisions & model.precisions
             model_information = {
                 'name': model.name,
                 'framework': model.framework,
-                'precisions': str(precisions_to_send).replace(',', ';'),
+                'precisions': str(sorted(precisions_to_send)).replace(',', ';'),
             }
             telemetry.send_event('md', 'downloader_model', json.dumps(model_information))
 
+        downloader = Downloader(requested_precisions, args.output_dir, args.cache_dir, args.num_attempts)
+
         failed_models = downloader.bulk_download_model(models, reporter, args.jobs, args.progress_format)
 
         if failed_models:

tools/model_tools/src/openvino/model_zoo/omz_quantizer.py

@@ -49,11 +49,15 @@ def main():
     args = parser.parse_args()
 
     with _common.telemetry_session('Model Quantizer', 'quantizer') as telemetry:
-        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
+        args_count = sum([args.all, args.name is not None, args.list is not None, args.print_all])
+        if args_count == 0:
+            telemetry.send_event('md', 'quantizer_selection_mode', None)
+        else:
+            for mode in ['all', 'list', 'name', 'print_all']:
+                if getattr(args, mode):
+                    telemetry.send_event('md', 'quantizer_selection_mode', mode)
 
-        for mode in ['all', 'list', 'name']:
-            if getattr(args, mode):
-                telemetry.send_event('md', 'quantizer_selection_mode', mode)
+        models = _configuration.load_models_from_args(parser, args, _common.MODEL_ROOT)
 
         if args.precisions is None:
             requested_precisions = _common.KNOWN_QUANTIZED_PRECISIONS.keys()
@@ -64,7 +68,7 @@ def main():
             model_information = {
                 'name': model.name,
                 'framework': model.framework,
-                'precisions': str(requested_precisions).replace(',', ';'),
+                'precisions': str(sorted(requested_precisions)).replace(',', ';'),
             }
             telemetry.send_event('md', 'quantizer_model', json.dumps(model_information))