Retrieving an Algorithm via REST API

Overview

Description	Retrieve a specific algorithm.
Resource Path	`/api/configs/algorithms/{algorithmName}`
HTTP Method	`GET`
Request/Response Format	application/json

Parameter description

Parameter	Description
`{algorithmName}`	The name of the algorithm that you need to retrieve.

Example

GET https://localhost:9443/api/configs/algorithms/{algorithmName}

Sample cURL command

curl -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -v https://localhost:9443/api/configs/algorithms/LINEAR_REGRESSION -k

Sample output

{
"interpretability":5,
"scalability":5,
"multicollinearity":1,
"dimensionality":5,
"name":"LINEAR_REGRESSION",
"type":"Numerical_Prediction",
"parameters":
[
{
"value":"100",
"key":"Iterations",
"description":"Number of times optimizer runs before completing the\n\t\t\t\t\toptimization process. This parameter value should be an integer\n\t\t\t\t\tgreater than 0.\n\t\t\t\t"
},
{
"value":"0.001",
"key":"Learning_Rate",
"description":"Step size of the optimization algorithm. This parameter\n\t\t\t\t\tvalue should be between 0 and 1, 1 inclusive.\n\t\t\t\t"
},
{
"value":"1",
"key":"SGD_Data_Fraction",
"description":"Fraction of the training dataset used per iteration\n\t\t\t\t\tin the optimization algorithm. This parameter value should be\n\t\t\t\t\tbetween 0 and 1, 1 inclusive.\n\t\t\t\t"
}
]
}

REST API response

HTTP status code

200

For descriptions of the HTTP status codes, see HTTP Status Codes.