feat: Add CSV Exporter (#757)

Adds CSV export provider
microsoft · Apr 26, 2019 · bae8338 · bae8338
1 parent ee6cc77
commit bae8338
Show file tree

Hide file tree

Showing 14 changed files with 334 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -195,8 +195,10 @@ Tagging and drawing regions is not possible while the video is playing.
 Once assets have been labeled, they can be exported into a variety of formats:
 
 * [Azure Custom Vision Service](https://azure.microsoft.com/en-us/services/cognitive-services/custom-vision-service/)
+* [Microsoft Cognitive Toolkit (CNTK)](https://github.com/Microsoft/CNTK)
 * TensorFlow (Pascal VOC and TFRecords)
 * VoTT (generic JSON schema)
+* Comma Separated Values (CSV)
 
 In addition, users may choose to export
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
         "dotenv": "^7.0.0",
         "google-protobuf": "^3.6.1",
         "jpeg-js": "^0.3.4",
+        "json2csv": "^4.5.0",
         "lodash": "^4.17.11",
         "md5.js": "^1.3.5",
         "node-fetch": "^2.3.0",
@@ -98,6 +99,7 @@
         "@types/dotenv": "^6.1.0",
         "@types/enzyme": "^3.1.15",
         "@types/jest": "23.3.9",
+        "@types/json2csv": "^4.4.0",
         "@types/node": "10.12.7",
         "@types/react": "16.7.6",
         "@types/react-dom": "16.0.9",

diff --git a/src/common/localization/en-us.ts b/src/common/localization/en-us.ts
@@ -302,17 +302,15 @@ export const english: IAppStrings = {
                         title: "Test / Train Split",
                         description: "The test train split to use for exported data",
                     },
-                },
-            },
-            vottJson: {
-                displayName: "VoTT JSON",
-                properties: {
                     includeImages: {
                         title: "Include Images",
                         description: "Whether or not to include binary image assets in target connection",
                     },
                 },
             },
+            vottJson: {
+                displayName: "VoTT JSON",
+            },
             azureCV: {
                 displayName: "Azure Custom Vision Service",
                 regions: {
@@ -385,6 +383,9 @@ export const english: IAppStrings = {
             cntk: {
                 displayName: "Microsoft Cognitive Toolkit (CNTK)",
             },
+            csv: {
+                displayName: "Comma Separated Values (CSV)",
+            },
         },
         messages: {
             saveSuccess: "Successfully saved export settings",

diff --git a/src/common/localization/es-cl.ts b/src/common/localization/es-cl.ts
@@ -305,17 +305,15 @@ export const spanish: IAppStrings = {
                         title: "La división para entrenar y comprobar",
                         description: "La división de datos para utilizar entre el entrenamiento y la comprobación",
                     },
-                },
-            },
-            vottJson: {
-                displayName: "VoTT JSON",
-                properties: {
                     includeImages: {
                         title: "Incluir imágenes",
                         description: "Si desea o no incluir activos de imagen binaria en la conexión de destino",
                     },
                 },
             },
+            vottJson: {
+                displayName: "VoTT JSON",
+            },
             azureCV: {
                 displayName: "Servicio de Visión Personalizada Azure",
                 regions: {
@@ -388,6 +386,9 @@ export const spanish: IAppStrings = {
             cntk: {
                 displayName: "Microsoft Cognitive Toolkit (CNTK)",
             },
+            csv: {
+                displayName: "Los valores separados por comas (CSV)",
+            },
         },
         messages: {
             saveSuccess: "Configuración de exportación guardada correctamente",

diff --git a/src/common/mockFactory.ts b/src/common/mockFactory.ts
@@ -638,14 +638,14 @@ export default class MockFactory {
 
     /**
      * Creates array of IExportProviderRegistrationOptions for the different providers
-     * vottJson, pascalVOC, azureCustomVision
+     * vottJson, PascalVOC, azureCustomVision, csv
      */
     public static createExportProviderRegistrations(): IExportProviderRegistrationOptions[] {
         const registrations: IExportProviderRegistrationOptions[] = [];
         registrations.push(MockFactory.createExportProviderRegistration("vottJson"));
         registrations.push(MockFactory.createExportProviderRegistration("pascalVOC"));
         registrations.push(MockFactory.createExportProviderRegistration("azureCustomVision"));
-
+        registrations.push(MockFactory.createExportProviderRegistration("csv"));
         return registrations;
     }
 

diff --git a/src/common/strings.ts b/src/common/strings.ts
@@ -299,17 +299,15 @@ export interface IAppStrings {
                         title: string,
                         description: string,
                     },
-                },
-            },
-            vottJson: {
-                displayName: string,
-                properties: {
                     includeImages: {
                         title: string,
                         description: string,
                     },
                 },
             },
+            vottJson: {
+                displayName: string,
+            },
             azureCV: {
                 displayName: string,
                 regions: {
@@ -382,6 +380,9 @@ export interface IAppStrings {
             cntk: {
                 displayName: string,
             },
+            csv: {
+                displayName: string,
+            },
         },
         messages: {
             saveSuccess: string;

diff --git a/src/providers/export/csv.json b/src/providers/export/csv.json
@@ -0,0 +1,28 @@
+{
+    "type": "object",
+    "title": "${strings.export.providers.csv.displayName}",
+    "properties": {
+        "assetState": {
+            "type": "string",
+            "title": "${strings.export.providers.common.properties.assetState.title}",
+            "description": "${strings.export.providers.common.properties.assetState.description}",
+            "enum": [
+                "all",
+                "visited",
+                "tagged"
+            ],
+            "default": "visited",
+            "enumNames": [
+                "${strings.export.providers.common.properties.assetState.options.all}",
+                "${strings.export.providers.common.properties.assetState.options.visited}",
+                "${strings.export.providers.common.properties.assetState.options.tagged}"
+            ]
+        },
+        "includeImages": {
+            "type": "boolean",
+            "default": true,
+            "title": "${strings.export.providers.common.properties.includeImages.title}",
+            "description": "${strings.export.providers.common.properties.includeImages.description}"
+        }
+    }
+}