The SubmitX Collaboration Platform exposes Application Programming Interface (API) which conforms to Representational State Transfer (ReST) architecture style. These APIs can be accessed by a software program or through the CURL command by providing a valid access token. The manageable resource at the server side is the machine learning model (referred to as “Model” henceforth) which is persisted as a brain file.
Whenever an API is invoked, an on-demand “SubmitX Brain” instance is loaded into the memory which in turn loads the resource (the model on which the operation is invoked) from the database. This instance stays alive till the request is processed and does not rely on the user session.This statelessness of the platform allows the load-balancer to distribute the incoming requests to any worker node and thus makes it highly scalable.
As a starting point the API provides a discovery interface to the user to fetch the models owned by the user, allows the user to read a representational state of the model (in JSON format) and perform various operations on the model like editing the model, data preparation, feature importance calculation, algorithm selection, hyperparameter tuning, learn, deploy, share, save, predict and forecast.
The APIs can be broadly categorized into
- User Management and Access Control
- Register a new user
- Fetch User Profile along with the following information
- user category
- subscription status
- available algorithms
- list of hyperparameters per algorithm
- available feature engineering nodes
- list of permissions
- Fetch the access rights / model shared with other user.
- Modify the access rights of the model towards a particular user.
- Share a model with another registered user
- Assign / Revoke the model access rights to / from another user
- List the models that the user has access to.
- View a learnt model and it’s properties like model owner, training algorithm, model diagnostics etc.
- Create a model from raw data
- Prepare a model
- Prepare + Feature Importance
- Prepare + Learn a model
- Prepare + Learn + Deploy a model
- Save a model
- Predict the output
- Check whether the service is running
- Fetch the state of a running task
- Fetch task history
- Clear task history
- Upload a raw file in the Sandbox
- Download prepared data
- Download a log file from Sandbox
- Clean all log files in Sandbox
- Fetch all file names from Sandbox along with file details.
Few samples are shown below
Check whether the server is alive and processing requests
|accessToken||<accessToken> received during registration|
List the models that you have access to.