Welcome
Developer Guide
Xplain
Explainability gives an explanation about Prediction and Model.
Xplaining Batch Prediction

Release Notes
Installation Guide
Developer Guide
- Overview
  To access the Marketing AION REST API interface, use the Docker Desktop application to start the Docker container.
- Tracker
- API Status
  Use these APIs to get the status and set the status of the different types of API.
- Data Handler Overview
  Data Handler has four different APIs, and three of the APIs represent a different method uploading data.
- Training
  For Training, you can execute either of the generic training by using Train for pipeline API.
- Prediction
  The Prediction section lists APIs that are used for handling single prediction and batch prediction.
- Model Inference (beta)
- Download-model
  These APIs are used to download Python package, Docker container package, and Mlac.
- Monitoring
  Monitoring ML models checks for changes in data distribution ensuring that data is maintaining an acceptable level of variation.
- Xplain
  Explainability gives an explanation about Prediction and Model.
  - Xplaining Model
    xplain Model API gives the insights of input data and explain the details of its important features.
  - Xplaining Prediction
    Xplain Prediction API explains the details about prediction concerning its precision, confidence, reason, along with force plot and decision plot.
  - Xplaining Batch Prediction
- Usecases
  Use the following APIs to retrieve the Use Case list, to delete use cases, and to retrieve the logs.
- EDA
- AutoPilot
  This Autopilot Mode refers to a feature that allows users to build an automated model without direct human intervention.
- Data Generator
- Building Usecases with API
  To build a usecase or to train a model, complete the following steps:
MLAC User Guide
User Guide

Xplaining Batch Prediction

Method: POST

Endpoint: /v1/aion/xplain/xplainbatchprediction/

Request Parameters


usecaseid	Mandatory	The ID of the use case for which you want the xplain model.
version	Mandatory	The version number of the model.
file		Upload a file that contains batch data, preferably in JSON format.

After providing the values, click Execute.

Response Parameters

After clicking Execute, the system returns the FileResponse and upon clicking download link, it will download the xplainbatchprediciton HTML file. The HTML file will contain the xplain batch prediction results for top five rows and graphs for each row accordingly.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.