ML(Machine Learning) Workbench Project Service Developer Guide

1.Overview

This is the developers guide to ML Workbench Project Service

1.1. What is ML Workbench Project Service?

ML Workbench Project Service expose API to allow to perform CRUD operation on Project in ML Workbench.

2. Technology and Frameworks

List of the development languages, frameworks, etc.

  1. Springboot 2.1.3.RELEASE
  2. Java 8
  3. Maven 4.0.0
  4. Jackson 2.7.5
  5. JUnit 4.12

3.Project Resources

4. Development Setup

  1. Clone or download code from “Gerrit repo” mentioned above.
  2. Import project-service Project in IDE (viz., Eclipse or STC)
  3. Once successfully imported, set the required properties in application.properties file.
  4. Run as Springboot application.
  5. Access using Swagger UI : http://localhost:9088/mlWorkbench/v1/project/swagger-ui.html#

6. Once you get the Swagger UI, click Authorize button and provide JWT token as below : Bearer <JWT token for Acumos User>

Note: JWT token value can be obtained after successful login in Acumos.

  1. After successfully setting Authorize value, API are available to access. Following are the sample inputs :
  1. Create Project :

“authenticatedUserId” : <Acumos User login ID>

“project” : {

“projectId”: {

“name”: “<Project name e.g. TestProject>”, “versionId”: {

“label”: “<version e.g. 0.0.1>”
}
}, “description”: “<Project description>”

}

  1. Update Project :

“authenticatedUserId” : <Acumos User login ID>

“project” : {

“projectId”: {

“name”: “<Project name e.g. TestProject>”, “versionId”: {

“label”: “<version e.g. 0.0.1>”
}
}, “description”: “<Project description>”

}

“projectId” : <Project UUID to be updated>

  1. List Project :

“authenticatedUserId” : <Acumos User login ID>

  1. View (Get) Project :

“authenticatedUserId” : <Acumos User login ID>

“projectId” : <Project UUID>

  1. Delete Project :

“authenticatedUserId” : <Acumos User login ID>

“projectId” : <Project UUID>