This documentation is for Machine Learner 1.0.0. View documentation for the latest release.
||
Skip to end of metadata
Go to start of metadata

Overview

DescriptionSet hyper parameters for the selected algorithm of an analysis.
Resource Path

/api/analyses/{id}/hyperParams

HTTP MethodPOST
Request/Response Formatapplication/json
Query ParameteralgorithmName

Parameter description

Parameter
Description
{id}ID of the analysis to which, you need to set hyper parameters for the selected algorithm.
algorithmNameName of the learning algorithm on which analysis is created.

Sample cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -vhttps://localhost:9443/api/analyses/1/hyperParams?algorithmName=LINEAR_REGRESSION -k -v -d @'create-hyper-parameters.json'
  • The path to the JSON file that defines the hyper parameters needs to be defined as the <JSON_PAYLOAD> value. (e.g. create-hyper-parameters.json)

Example

For information on the property definitions that are used in a JSON file to define hyper parameters, see, see Sample Hyper Parameters Definition.

POST https://localhost:9443/api/analyses/{id}/hyperParams?algorithmName=LINEAR_REGRESSION
[
    {
        "key": "Iterations",
        "value": "100"
    },
    {
        "key": "Learning_Rate",
        "value": "0.1"
    },
    {
        "key": "SGD_Data_Fraction",
        "value": "1"
    }
]

REST API response

HTTP status code

200

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

  • No labels