Project: export as a dataset (cvat-ai#3365)

.github/workflows/main.yml

@@ -5,8 +5,7 @@ on:
       - 'master'
       - 'develop'
   pull_request:
-    branches:
-      - '*'
+
 jobs:
   Unit_testing:
       runs-on: ubuntu-latest

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Notification if the browser does not support nesassary API
+- Added ability to export project as a dataset (<https://github.com/openvinotoolkit/cvat/pull/3365>)
 - Additional inline tips in interactors with demo gifs (<https://github.com/openvinotoolkit/cvat/pull/3473>)
 
 ### Changed

cvat-core/package.json

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

cvat-core/src/annotations.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2020 Intel Corporation
+// Copyright (C) 2019-2021 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -8,8 +8,9 @@
     const AnnotationsSaver = require('./annotations-saver');
     const AnnotationsHistory = require('./annotations-history');
     const { checkObjectType } = require('./common');
-    const { Task } = require('./session');
-    const { Loader, Dumper } = require('./annotation-formats');
+    const { Project } = require('./project');
+    const { Task, Job } = require('./session');
+    const { Loader } = require('./annotation-formats');
     const { ScriptingError, DataError, ArgumentError } = require('./exceptions');
 
     const jobCache = new WeakMap();
@@ -50,6 +51,7 @@
                 stopFrame,
                 frameMeta,
             });
+            // eslint-disable-next-line no-unsanitized/method
             collection.import(rawAnnotations);
 
             const saver = new AnnotationsSaver(rawAnnotations.version, collection, session);
@@ -232,27 +234,12 @@
         await serverProxy.annotations.uploadAnnotations(sessionType, session.id, file, loader.name);
     }
 
-    async function dumpAnnotations(session, name, dumper) {
-        if (!(dumper instanceof Dumper)) {
-            throw new ArgumentError('A dumper must be instance of Dumper class');
-        }
-
-        let result = null;
-        const sessionType = session instanceof Task ? 'task' : 'job';
-        if (sessionType === 'job') {
-            result = await serverProxy.annotations.dumpAnnotations(session.task.id, name, dumper.name);
-        } else {
-            result = await serverProxy.annotations.dumpAnnotations(session.id, name, dumper.name);
-        }
-
-        return result;
-    }
-
     function importAnnotations(session, data) {
         const sessionType = session instanceof Task ? 'task' : 'job';
         const cache = getCache(sessionType);
 
         if (cache.has(session)) {
+            // eslint-disable-next-line no-unsanitized/method
             return cache.get(session).collection.import(data);
         }
 
@@ -274,16 +261,25 @@
         );
     }
 
-    async function exportDataset(session, format) {
+    async function exportDataset(instance, format, name, saveImages = false) {
         if (!(format instanceof String || typeof format === 'string')) {
             throw new ArgumentError('Format must be a string');
         }
-        if (!(session instanceof Task)) {
-            throw new ArgumentError('A dataset can only be created from a task');
+        if (!(instance instanceof Task || instance instanceof Project || instance instanceof Job)) {
+            throw new ArgumentError('A dataset can only be created from a job, task or project');
+        }
+        if (typeof saveImages !== 'boolean') {
+            throw new ArgumentError('Save images parameter must be a boolean');
         }
 
         let result = null;
-        result = await serverProxy.tasks.exportDataset(session.id, format);
+        if (instance instanceof Task) {
+            result = await serverProxy.tasks.exportDataset(instance.id, format, name, saveImages);
+        } else if (instance instanceof Job) {
+            result = await serverProxy.tasks.exportDataset(instance.task.id, format, name, saveImages);
+        } else {
+            result = await serverProxy.projects.exportDataset(instance.id, format, name, saveImages);
+        }
 
         return result;
     }
@@ -367,7 +363,6 @@
         annotationsStatistics,
         selectObject,
         uploadAnnotations,
-        dumpAnnotations,
         importAnnotations,
         exportAnnotations,
         exportDataset,

cvat-core/src/api.js

@@ -18,6 +18,7 @@ function build() {
     const Review = require('./review');
     const { Job, Task } = require('./session');
     const { Project } = require('./project');
+    const implementProject = require('./project-implementation');
     const { Attribute, Label } = require('./labels');
     const MLModel = require('./ml-model');
     const { FrameData } = require('./frames');
@@ -754,7 +755,7 @@ function build() {
          */
         classes: {
             User,
-            Project,
+            Project: implementProject(Project),
             Task,
             Job,
             Log,

cvat-core/src/project-implementation.js

@@ -0,0 +1,74 @@
+// Copyright (C) 2021 Intel Corporation
+//
+// SPDX-License-Identifier: MIT
+
+(() => {
+    const serverProxy = require('./server-proxy');
+    const { getPreview } = require('./frames');
+
+    const { Project } = require('./project');
+    const { exportDataset } = require('./annotations');
+
+    function implementProject(projectClass) {
+        projectClass.prototype.save.implementation = async function () {
+            const trainingProjectCopy = this.trainingProject;
+            if (typeof this.id !== 'undefined') {
+                // project has been already created, need to update some data
+                const projectData = {
+                    name: this.name,
+                    assignee_id: this.assignee ? this.assignee.id : null,
+                    bug_tracker: this.bugTracker,
+                    labels: [...this._internalData.labels.map((el) => el.toJSON())],
+                };
+
+                if (trainingProjectCopy) {
+                    projectData.training_project = trainingProjectCopy;
+                }
+
+                await serverProxy.projects.save(this.id, projectData);
+                return this;
+            }
+
+            // initial creating
+            const projectSpec = {
+                name: this.name,
+                labels: [...this.labels.map((el) => el.toJSON())],
+            };
+
+            if (this.bugTracker) {
+                projectSpec.bug_tracker = this.bugTracker;
+            }
+
+            if (trainingProjectCopy) {
+                projectSpec.training_project = trainingProjectCopy;
+            }
+
+            const project = await serverProxy.projects.create(projectSpec);
+            return new Project(project);
+        };
+
+        projectClass.prototype.delete.implementation = async function () {
+            const result = await serverProxy.projects.delete(this.id);
+            return result;
+        };
+
+        projectClass.prototype.preview.implementation = async function () {
+            if (!this._internalData.task_ids.length) {
+                return '';
+            }
+            const frameData = await getPreview(this._internalData.task_ids[0]);
+            return frameData;
+        };
+
+        projectClass.prototype.annotations.exportDataset.implementation = async function (
+            format, saveImages, customName,
+        ) {
+            const result = exportDataset(this, format, customName, saveImages);
+            return result;
+        };
+
+        return projectClass;
+    }
+
+    module.exports = implementProject;
+})();

cvat-core/src/project.js

@@ -4,11 +4,9 @@
 
 (() => {
     const PluginRegistry = require('./plugins');
-    const serverProxy = require('./server-proxy');
     const { ArgumentError } = require('./exceptions');
     const { Task } = require('./session');
     const { Label } = require('./labels');
-    const { getPreview } = require('./frames');
     const User = require('./user');
 
     /**
@@ -203,7 +201,7 @@
                         },
                     },
                     /**
-                     * Tasks linked with the project
+                     * Tasks related with the project
                      * @name tasks
                      * @type {module:API.cvat.classes.Task[]}
                      * @memberof module:API.cvat.classes.Project
@@ -214,7 +212,7 @@
                         get: () => [...data.tasks],
                     },
                     /**
-                     * Subsets array for linked tasks
+                     * Subsets array for related tasks
                      * @name subsets
                      * @type {string[]}
                      * @memberof module:API.cvat.classes.Project
@@ -254,6 +252,13 @@
                     },
                 }),
             );
+
+            // When we call a function, for example: project.annotations.get()
+            // In the method get we lose the project context
+            // So, we need return it
+            this.annotations = {
+                exportDataset: Object.getPrototypeOf(this).annotations.exportDataset.bind(this),
+            };
         }
 
         /**
@@ -289,7 +294,7 @@
         }
 
         /**
-         * Method deletes a task from a server
+         * Method deletes a project from a server
          * @method delete
          * @memberof module:API.cvat.classes.Project
          * @readonly
@@ -304,57 +309,28 @@
         }
     }
 
+    Object.defineProperties(
+        Project.prototype,
+        Object.freeze({
+            annotations: Object.freeze({
+                value: {
+                    async exportDataset(format, saveImages, customName = '') {
+                        const result = await PluginRegistry.apiWrapper.call(
+                            this,
+                            Project.prototype.annotations.exportDataset,
+                            format,
+                            saveImages,
+                            customName,
+                        );
+                        return result;
+                    },
+                },
+                writable: true,
+            }),
+        }),
+    );
+
     module.exports = {
         Project,
     };
-
-    Project.prototype.save.implementation = async function () {
-        const trainingProjectCopy = this.trainingProject;
-        if (typeof this.id !== 'undefined') {
-            // project has been already created, need to update some data
-            const projectData = {
-                name: this.name,
-                assignee_id: this.assignee ? this.assignee.id : null,
-                bug_tracker: this.bugTracker,
-                labels: [...this._internalData.labels.map((el) => el.toJSON())],
-            };
-
-            if (trainingProjectCopy) {
-                projectData.training_project = trainingProjectCopy;
-            }
-
-            await serverProxy.projects.save(this.id, projectData);
-            return this;
-        }
-
-        // initial creating
-        const projectSpec = {
-            name: this.name,
-            labels: [...this.labels.map((el) => el.toJSON())],
-        };
-
-        if (this.bugTracker) {
-            projectSpec.bug_tracker = this.bugTracker;
-        }
-
-        if (trainingProjectCopy) {
-            projectSpec.training_project = trainingProjectCopy;
-        }
-
-        const project = await serverProxy.projects.create(projectSpec);
-        return new Project(project);
-    };
-
-    Project.prototype.delete.implementation = async function () {
-        const result = await serverProxy.projects.delete(this.id);
-        return result;
-    };
-
-    Project.prototype.preview.implementation = async function () {
-        if (!this._internalData.task_ids.length) {
-            return '';
-        }
-        const frameData = await getPreview(this._internalData.task_ids[0]);
-        return frameData;
-    };
 })();