Commands model:principal_components/train

Build principal components model.

POST /v1/commands/

GET /v1/commands/:id

Request

Route

POST /v1/commands/

Body

name:

model:principal_components/train

arguments:

model : Model

<Missing Description>

frame : Frame

A frame to train the model on.

observation_columns : list

List of column(s) containing the observations.

mean_centered : bool (default=True)

Option to mean center the columns

k : int32 (default=None)

Principal component count. Default is the number of observation columns

Headers

Authorization: test_api_key_1
Content-type: application/json

Description

Creating a PrincipalComponents Model using the observation columns.

Response

Status

200 OK

Body

Returns information about the command. See the Response Body for Get Command here below. It is the same.

GET /v1/commands/:id

Request

Route

GET /v1/commands/18

Body

(None)

Headers

Authorization: test_api_key_1
Content-type: application/json

Response

Status

200 OK

Body

dict

dictionary

|A dictionary with trained Principal Components Model with the following keys: |‘column_means’: the list of the means of each observation column |‘k’: number of principal components used to train the model |‘mean_centered’: Flag indicating if the model was mean centered during training |‘observation_columns’: the list of observation columns on which the model was trained, |‘right_singular_vectors’: list of a list storing the right singular vectors of the specified columns of the input frame |‘singular_values’: list storing the singular values of the specified columns of the input frame