org.wso2.carbon.ml.rest.api

Class AnalysisApiV10

java.lang.Object

org.wso2.carbon.ml.rest.api.MLRestAPI

org.wso2.carbon.ml.rest.api.AnalysisApiV10

public class AnalysisApiV10
extends MLRestAPI

WSO2 ML Analyses API. All the operations related to Analyses are delegated from this class.

Constructor Summary

Constructors

Constructor and Description
AnalysisApiV10()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addCustomizedFeatures(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature> customizedFeatures) Adding customized features of this analysis.
javax.ws.rs.core.Response	addDefaultsIntoCustomizedFeatures(long analysisId, org.wso2.carbon.ml.commons.domain.MLCustomizedFeature customizedValues) load default features as customized features of this analysis.
javax.ws.rs.core.Response	addDefaultsIntoHyperParameters(long analysisId) loading default configurations as configurations (algorithm etc.) of this analysis.
javax.ws.rs.core.Response	addHyperParameters(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLHyperParameter> hyperParameters, String algorithmName) Adding hyper parameters for the selected algorithm of this analysis.
javax.ws.rs.core.Response	addModelConfiguration(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLModelConfiguration> modelConfigs) Adding configurations (algorithm etc.) of this analysis.
javax.ws.rs.core.Response	createAnalysis(org.wso2.carbon.ml.commons.domain.MLAnalysis analysis) Create a new Analysis of a project.
javax.ws.rs.core.Response	deleteAnalysis(long analysisId) delete an analysis of a given id.
javax.ws.rs.core.Response	getAlgorithmName(long analysisId) get the algorithm name of an analysis.
javax.ws.rs.core.Response	getAllAnalyses() Retrieve all analyses.
javax.ws.rs.core.Response	getAllFeatures(String analysisId) get all feature names of an analysis.
javax.ws.rs.core.Response	getAllModelsOfAnalysis(long analysisId) Get all models of a given analysis.
javax.ws.rs.core.Response	getAnalysis(String analysisName) Deprecated.
javax.ws.rs.core.Response	getfilteredFeatures(String analysisId, String featureType) get filtered feature names of an analysis.
javax.ws.rs.core.Response	getHyperParameters(long analysisId, String algorithmName) get hyper-parameters of an analysis.
javax.ws.rs.core.Response	getResponseVariable(long analysisId) get the response variable of an analysis.
javax.ws.rs.core.Response	getSummarizedFeatures(long analysisId, int limit, int offset) get summarized features of an analysis.
javax.ws.rs.core.Response	getSummaryStatistics(long analysisId, String featureName) get summarized statistics of a feature of an analysis.
javax.ws.rs.core.Response	getTrainDataFraction(long analysisId) get the train data fraction of an analysis.
javax.ws.rs.core.Response	options() HTTP Options method implementation for analysis API.

Methods inherited from class org.wso2.carbon.ml.rest.api.MLRestAPI

getTenantID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalysisApiV10

public AnalysisApiV10()

Method Detail

options

public javax.ws.rs.core.Response options()

HTTP Options method implementation for analysis API.

Returns:

createAnalysis

public javax.ws.rs.core.Response createAnalysis(org.wso2.carbon.ml.commons.domain.MLAnalysis analysis)

Create a new Analysis of a project.

addCustomizedFeatures

public javax.ws.rs.core.Response addCustomizedFeatures(long analysisId,
                                              List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature> customizedFeatures)

Adding customized features of this analysis.

addDefaultsIntoCustomizedFeatures

public javax.ws.rs.core.Response addDefaultsIntoCustomizedFeatures(long analysisId,
                                                          org.wso2.carbon.ml.commons.domain.MLCustomizedFeature customizedValues)

load default features as customized features of this analysis.

getSummarizedFeatures

public javax.ws.rs.core.Response getSummarizedFeatures(long analysisId,
                                              int limit,
                                              int offset)

get summarized features of an analysis.

getfilteredFeatures

public javax.ws.rs.core.Response getfilteredFeatures(String analysisId,
                                            String featureType)

get filtered feature names of an analysis.

getAllFeatures

public javax.ws.rs.core.Response getAllFeatures(String analysisId)

get all feature names of an analysis.

getResponseVariable

public javax.ws.rs.core.Response getResponseVariable(long analysisId)

get the response variable of an analysis.

getAlgorithmName

public javax.ws.rs.core.Response getAlgorithmName(long analysisId)

get the algorithm name of an analysis.

getTrainDataFraction

public javax.ws.rs.core.Response getTrainDataFraction(long analysisId)

get the train data fraction of an analysis.

getSummaryStatistics

public javax.ws.rs.core.Response getSummaryStatistics(long analysisId,
                                             String featureName)

get summarized statistics of a feature of an analysis.

addModelConfiguration

public javax.ws.rs.core.Response addModelConfiguration(long analysisId,
                                              List<org.wso2.carbon.ml.commons.domain.MLModelConfiguration> modelConfigs)

Adding configurations (algorithm etc.) of this analysis.

addHyperParameters

public javax.ws.rs.core.Response addHyperParameters(long analysisId,
                                           List<org.wso2.carbon.ml.commons.domain.MLHyperParameter> hyperParameters,
                                           String algorithmName)

Adding hyper parameters for the selected algorithm of this analysis.

getHyperParameters

public javax.ws.rs.core.Response getHyperParameters(long analysisId,
                                           String algorithmName)

get hyper-parameters of an analysis.

addDefaultsIntoHyperParameters

public javax.ws.rs.core.Response addDefaultsIntoHyperParameters(long analysisId)

loading default configurations as configurations (algorithm etc.) of this analysis.

getAnalysis

public javax.ws.rs.core.Response getAnalysis(String analysisName)

Deprecated.

Retrieving an analysis by a name.

getAllAnalyses

public javax.ws.rs.core.Response getAllAnalyses()

Retrieve all analyses.

getAllModelsOfAnalysis

public javax.ws.rs.core.Response getAllModelsOfAnalysis(long analysisId)

Get all models of a given analysis.

deleteAnalysis

public javax.ws.rs.core.Response deleteAnalysis(long analysisId)

delete an analysis of a given id.