Swagger file:metadata training job for TM 54/13654/1
authorSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:29:16 +0000 (10:59 +0530)
committerSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:29:16 +0000 (10:59 +0530)
Change-Id: Ifbc9b83bcb4eb90958bc4f7f6af71951da35a1c1
Signed-off-by: Swaraj Kumar <swaraj.kumar@samsung.com>
API_docs/training-manager.yaml

index e26200f..9796e85 100644 (file)
@@ -703,3 +703,57 @@ paths:
               Exception:
                 type: "string"
 
+  /trainingjobs/metadata/{trainingjob_name}:
+    get:
+      tags:
+        - Training Job
+      summary: "Get metadata for a training job"
+      description: "Fetches accuracy, version, and model download URL for all versions of the specified training job that have a FINISHED state and are not in the deletion process."
+      parameters:
+        - name: "trainingjob_name"
+          in: "path"
+          required: true
+          type: "string"
+          description: "Name of the training job"
+      responses:
+        200:
+          description: "Successful response with metadata"
+          schema:
+            type: "object"
+            properties:
+              Successed_metadata:
+                type: "array"
+                items:
+                  type: "object"
+                  properties:
+                    accuracy:
+                      type: "object"
+                      description: "Metrics of the model"
+                    version:
+                      type: "integer"
+                      description: "Version of the training job"
+                    url:
+                      type: "string"
+                      description: "URL for downloading the model"
+        400:
+          description: "Invalid training job name"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        404:
+          description: "Training job not found"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        500:
+          description: "Internal server error"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+