Add tf import checks and tests (cvat-ai#1567)

* Add tf import checks and tests

* implement disabled formats on server

* python 3.5 compatibility

* add checks to dm tests

* fix tests

* Support for disabled formats in UI

* add sorting for formats, mark grey disabled items

* update changelog

* advance package versions

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Throttling policy for unauthenticated users (<https://github.com/opencv/cvat/pull/1531>)
 - Added default label color table for mask export (https://github.com/opencv/cvat/pull/1549)
+- Added visual identification for unavailable formats (https://github.com/opencv/cvat/pull/1567)
 
 ### Changed
 - Removed information about e-mail from the basic user information (<https://github.com/opencv/cvat/pull/1627>)
@@ -19,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -
 
 ### Fixed
--
+- Fixed interpreter crash when trying to import `tensorflow` with no AVX instructions available (https://github.com/opencv/cvat/pull/1567)
 
 ### Security
 -

cvat-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cvat-core",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "Part of Computer Vision Tool which presents an interface for client-side integration",
   "main": "babel.config.js",
   "scripts": {

cvat-core/src/annotation-formats.js

@@ -15,6 +15,7 @@
                 name: initialData.name,
                 format: initialData.ext,
                 version: initialData.version,
+                enabled: initialData.enabled,
             };
 
             Object.defineProperties(this, {
@@ -48,6 +49,16 @@
                     */
                     get: () => data.version,
                 },
+                enabled: {
+                    /**
+                        * @name enabled
+                        * @type {string}
+                        * @memberof module:API.cvat.classes.Loader
+                        * @readonly
+                        * @instance
+                    */
+                    get: () => data.enabled,
+                },
             });
         }
     }
@@ -63,6 +74,7 @@
                 name: initialData.name,
                 format: initialData.ext,
                 version: initialData.version,
+                enabled: initialData.enabled,
             };
 
             Object.defineProperties(this, {
@@ -96,6 +108,16 @@
                     */
                     get: () => data.version,
                 },
+                enabled: {
+                    /**
+                        * @name enabled
+                        * @type {string}
+                        * @memberof module:API.cvat.classes.Loader
+                        * @readonly
+                        * @instance
+                    */
+                    get: () => data.enabled,
+                },
             });
         }
     }

cvat-ui/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cvat-ui",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "CVAT single-page application",
   "main": "src/index.tsx",
   "scripts": {

cvat-ui/src/components/actions-menu/actions-menu.tsx

@@ -16,8 +16,8 @@ interface Props {
     taskMode: string;
     bugTracker: string;
 
-    loaders: string[];
-    dumpers: string[];
+    loaders: any[];
+    dumpers: any[];
     loadActivity: string | null;
     dumpActivities: string[] | null;
     exportActivities: string[] | null;

cvat-ui/src/components/actions-menu/dump-submenu.tsx

@@ -15,7 +15,7 @@ function isDefaultFormat(dumperName: string, taskMode: string): boolean {
 interface Props {
     taskMode: string;
     menuKey: string;
-    dumpers: string[];
+    dumpers: any[];
     dumpActivities: string[] | null;
 }
 
@@ -30,17 +30,21 @@ export default function DumpSubmenu(props: Props): JSX.Element {
     return (
         <Menu.SubMenu key={menuKey} title='Dump annotations'>
             {
-                dumpers.map((dumper: string): JSX.Element => {
-                    const pending = (dumpActivities || []).includes(dumper);
-                    const isDefault = isDefaultFormat(dumper, taskMode);
+                dumpers
+                    .sort((a: any, b: any) => a.name.localeCompare(b.name))
+                    .map((dumper: any): JSX.Element =>
+                {
+                    const pending = (dumpActivities || []).includes(dumper.name);
+                    const disabled = !dumper.enabled || pending;
+                    const isDefault = isDefaultFormat(dumper.name, taskMode);
                     return (
                         <Menu.Item
-                            key={dumper}
-                            disabled={pending}
+                            key={dumper.name}
+                            disabled={disabled}
                             className='cvat-menu-dump-submenu-item'
                         >
                             <Icon type='download' />
-                            <Text strong={isDefault}>{dumper}</Text>
+                            <Text strong={isDefault} disabled={disabled}>{dumper.name}</Text>
                             {pending && <Icon style={{ marginLeft: 10 }} type='loading' />}
                         </Menu.Item>
                     );

cvat-ui/src/components/actions-menu/export-submenu.tsx

@@ -9,7 +9,7 @@ import Text from 'antd/lib/typography/Text';
 
 interface Props {
     menuKey: string;
-    exporters: string[];
+    exporters: any[];
     exportActivities: string[] | null;
 }
 
@@ -23,16 +23,20 @@ export default function ExportSubmenu(props: Props): JSX.Element {
     return (
         <Menu.SubMenu key={menuKey} title='Export as a dataset'>
             {
-                exporters.map((exporter: string): JSX.Element => {
-                    const pending = (exportActivities || []).includes(exporter);
+                exporters
+                    .sort((a: any, b: any) => a.name.localeCompare(b.name))
+                    .map((exporter: any): JSX.Element =>
+                {
+                    const pending = (exportActivities || []).includes(exporter.name);
+                    const disabled = !exporter.enabled || pending;
                     return (
                         <Menu.Item
-                            key={exporter}
-                            disabled={pending}
+                            key={exporter.name}
+                            disabled={disabled}
                             className='cvat-menu-export-submenu-item'
                         >
                             <Icon type='export' />
-                            <Text>{exporter}</Text>
+                            <Text disabled={disabled}>{exporter.name}</Text>
                             {pending && <Icon style={{ marginLeft: 10 }} type='loading' />}
                         </Menu.Item>
                     );

cvat-ui/src/components/actions-menu/load-submenu.tsx

@@ -11,7 +11,7 @@ import Text from 'antd/lib/typography/Text';
 
 interface Props {
     menuKey: string;
-    loaders: string[];
+    loaders: any[];
     loadActivity: string | null;
     onFileUpload(file: File): void;
 }
@@ -27,13 +27,20 @@ export default function LoadSubmenu(props: Props): JSX.Element {
     return (
         <Menu.SubMenu key={menuKey} title='Upload annotations'>
             {
-                loaders.map((_loader: string): JSX.Element => {
-                    const [loader, accept] = _loader.split('::');
-                    const pending = loadActivity === loader;
+                loaders
+                    .sort((a: any, b: any) => a.name.localeCompare(b.name))
+                    .map((loader: any): JSX.Element =>
+                {
+                    const accept = loader.format
+                        .split(',')
+                        .map((x: string) => '.' + x.trimStart())
+                        .join(', '); // add '.' to each extension in a list
+                    const pending = loadActivity === loader.name;
+                    const disabled = !loader.enabled || !!loadActivity;
                     return (
                         <Menu.Item
-                            key={loader}
-                            disabled={!!loadActivity}
+                            key={loader.name}
+                            disabled={disabled}
                             className='cvat-menu-load-submenu-item'
                         >
                             <Upload
@@ -45,9 +52,9 @@ export default function LoadSubmenu(props: Props): JSX.Element {
                                     return false;
                                 }}
                             >
-                                <Button block type='link' disabled={!!loadActivity}>
+                                <Button block type='link' disabled={disabled}>
                                     <Icon type='upload' />
-                                    <Text>{loader}</Text>
+                                    <Text>{loader.name}</Text>
                                     {pending && <Icon style={{ marginLeft: 10 }} type='loading' />}
                                 </Button>
                             </Upload>

cvat-ui/src/components/annotation-page/top-bar/annotation-menu.tsx

@@ -13,8 +13,8 @@ import ReIDPlugin from './reid-plugin';
 
 interface Props {
     taskMode: string;
-    loaders: string[];
-    dumpers: string[];
+    loaders: any[];
+    dumpers: any[];
     loadActivity: string | null;
     dumpActivities: string[] | null;
     exportActivities: string[] | null;

cvat-ui/src/containers/actions-menu/actions-menu.tsx

@@ -134,7 +134,7 @@ function ActionsMenuContainer(props: OwnProps & StateToProps & DispatchToProps):
                     dumpAnnotations(taskInstance, dumper);
                 }
             } else if (action === Actions.LOAD_TASK_ANNO) {
-                const [format] = additionalKey.split('::');
+                const format = additionalKey;
                 const [loader] = loaders
                     .filter((_loader: any): boolean => _loader.name === format);
                 if (loader && file) {
@@ -166,8 +166,8 @@ function ActionsMenuContainer(props: OwnProps & StateToProps & DispatchToProps):
             taskID={taskInstance.id}
             taskMode={taskInstance.mode}
             bugTracker={taskInstance.bugTracker}
-            loaders={loaders.map((loader: any): string => `${loader.name}::${loader.format}`)}
-            dumpers={dumpers.map((dumper: any): string => dumper.name)}
+            loaders={loaders}
+            dumpers={dumpers}
             loadActivity={loadActivity}
             dumpActivities={dumpActivities}
             exportActivities={exportActivities}

cvat-ui/src/containers/annotation-page/top-bar/annotation-menu.tsx

@@ -123,7 +123,7 @@ function AnnotationMenuContainer(props: Props): JSX.Element {
                     dumpAnnotations(jobInstance.task, dumper);
                 }
             } else if (action === Actions.LOAD_JOB_ANNO) {
-                const [format] = additionalKey.split('::');
+                const format = additionalKey;
                 const [loader] = loaders
                     .filter((_loader: any): boolean => _loader.name === format);
                 if (loader && file) {
@@ -150,8 +150,8 @@ function AnnotationMenuContainer(props: Props): JSX.Element {
     return (
         <AnnotationMenuComponent
             taskMode={jobInstance.task.mode}
-            loaders={loaders.map((loader: any): string => loader.name)}
-            dumpers={dumpers.map((dumper: any): string => dumper.name)}
+            loaders={loaders}
+            dumpers={dumpers}
             loadActivity={loadActivity}
             dumpActivities={dumpActivities}
             exportActivities={exportActivities}

cvat/apps/dataset_manager/formats/registry.py

@@ -13,6 +13,7 @@ class _Format:
     EXT = ''
     VERSION = ''
     DISPLAY_NAME = '{NAME} {VERSION}'
+    ENABLED = True
 
 class Exporter(_Format):
     def __call__(self, dst_file, task_data, **options):
@@ -22,7 +23,7 @@ class Importer(_Format):
     def __call__(self, src_file, task_data, **options):
         raise NotImplementedError()
 
-def _wrap_format(f_or_cls, klass, name, version, ext, display_name):
+def _wrap_format(f_or_cls, klass, name, version, ext, display_name, enabled):
     import inspect
     assert inspect.isclass(f_or_cls) or inspect.isfunction(f_or_cls)
     if inspect.isclass(f_or_cls):
@@ -44,25 +45,29 @@ def __call__(self, *args, **kwargs):
     target.DISPLAY_NAME = (display_name or klass.DISPLAY_NAME).format(
         NAME=name, VERSION=version, EXT=ext)
     assert all([target.NAME, target.VERSION, target.EXT, target.DISPLAY_NAME])
+    target.ENABLED = enabled
+
     return target
 
 EXPORT_FORMATS = {}
-def exporter(name, version, ext, display_name=None):
+def exporter(name, version, ext, display_name=None, enabled=True):
     assert name not in EXPORT_FORMATS, "Export format '%s' already registered" % name
     def wrap_with_params(f_or_cls):
         t = _wrap_format(f_or_cls, Exporter,
-            name=name, ext=ext, version=version, display_name=display_name)
+            name=name, ext=ext, version=version, display_name=display_name,
+            enabled=enabled)
         key = t.DISPLAY_NAME
         assert key not in EXPORT_FORMATS, "Export format '%s' already registered" % name
         EXPORT_FORMATS[key] = t
         return t
     return wrap_with_params
 
 IMPORT_FORMATS = {}
-def importer(name, version, ext, display_name=None):
+def importer(name, version, ext, display_name=None, enabled=True):
     def wrap_with_params(f_or_cls):
         t = _wrap_format(f_or_cls, Importer,
-            name=name, ext=ext, version=version, display_name=display_name)
+            name=name, ext=ext, version=version, display_name=display_name,
+            enabled=enabled)
         key = t.DISPLAY_NAME
         assert key not in IMPORT_FORMATS, "Import format '%s' already registered" % name
         IMPORT_FORMATS[key] = t

cvat/apps/dataset_manager/formats/tfrecord.py

@@ -14,7 +14,15 @@
 from .registry import dm_env, exporter, importer
 
 
-@exporter(name='TFRecord', ext='ZIP', version='1.0')
+from datumaro.util.tf_util import import_tf
+try:
+    import_tf()
+    tf_available = True
+except ImportError:
+    tf_available = False
+
+
+@exporter(name='TFRecord', ext='ZIP', version='1.0', enabled=tf_available)
 def _export(dst_file, task_data, save_images=False):
     extractor = CvatTaskDataExtractor(task_data, include_images=save_images)
     extractor = Dataset.from_extractors(extractor) # apply lazy transforms
@@ -25,7 +33,7 @@ def _export(dst_file, task_data, save_images=False):
 
         make_zip_archive(temp_dir, dst_file)
 
-@importer(name='TFRecord', ext='ZIP', version='1.0')
+@importer(name='TFRecord', ext='ZIP', version='1.0', enabled=tf_available)
 def _import(src_file, task_data):
     with TemporaryDirectory() as tmp_dir:
         Archive(src_file.name).extractall(tmp_dir)

cvat/apps/dataset_manager/serializers.py

@@ -9,6 +9,7 @@ class DatasetFormatSerializer(serializers.Serializer):
     name = serializers.CharField(max_length=64, source='DISPLAY_NAME')
     ext = serializers.CharField(max_length=64, source='EXT')
     version = serializers.CharField(max_length=64, source='VERSION')
+    enabled = serializers.BooleanField(source='ENABLED')
 
 class DatasetFormatsSerializer(serializers.Serializer):
     importers = DatasetFormatSerializer(many=True)

cvat/apps/dataset_manager/tests/_test_formats.py

@@ -335,6 +335,9 @@ def check(file_path):
                 self.assertTrue(len(f.read()) != 0)
 
         for f in dm.views.get_export_formats():
+            if not f.ENABLED:
+                self.skipTest("Format is disabled")
+
             format_name = f.DISPLAY_NAME
             for save_images in { True, False }:
                 with self.subTest(format=format_name, save_images=save_images):
@@ -359,6 +362,9 @@ def test_empty_images_are_exported(self):
             ('YOLO 1.1', 'yolo'),
         ]:
             with self.subTest(format=format_name):
+                if not dm.formats.registry.EXPORT_FORMATS[format_name].ENABLED:
+                    self.skipTest("Format is disabled")
+
                 task = self._generate_task()
 
                 def check(file_path):