Documentation

Google_Service_CloudMachineLearningEngine_Resource_ProjectsLocationsStudiesTrials extends Google_Service_Resource
in package

Application

The "trials" collection of methods.

Typical usage is: $mlService = new Google_Service_CloudMachineLearningEngine(...); $trials = $mlService->trials;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addMeasurement() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial: Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
checkEarlyStoppingState() : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation: Checks whether a trial should stop or not. Returns a long-running operation.
complete() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial: Marks a trial as complete. (trials.complete)
create() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial: Adds a user provided trial to a study. (trials.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudMachineLearningEngine_GoogleProtobufEmpty: Deletes a trial. (trials.delete)
get() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial: Gets a trial. (trials.get)
listProjectsLocationsStudiesTrials() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListTrialsResponse: Lists the trials associated with a study.
stop() : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial: Stops a trial. (trials.stop)
suggest() : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation: Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. (trials.suggest)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

addMeasurement()

Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.


    public
                addMeasurement(string $name, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1AddTrialMeasurementRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial

(trials.addMeasurement)

Parameters

$name : string: Required. The trial name.
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1AddTrialMeasurementRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

checkEarlyStoppingState()

Checks whether a trial should stop or not. Returns a long-running operation.


    public
                checkEarlyStoppingState(string $name, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. (trials.checkEarlyStoppingState)

Parameters

$name : string: Required. The trial name.
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation —

complete()

Marks a trial as complete. (trials.complete)


    public
                complete(string $name, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1CompleteTrialRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial

Parameters

$name : string: Required. The trial name.metat
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1CompleteTrialRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial —

create()

Adds a user provided trial to a study. (trials.create)


    public
                create(string $parent, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial

Parameters

$parent : string: Required. The name of the study that the trial belongs to.
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a trial. (trials.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleProtobufEmpty

Parameters

$name : string: Required. The trial name.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleProtobufEmpty —

get()

Gets a trial. (trials.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial

Parameters

$name : string: Required. The trial name.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial —

listProjectsLocationsStudiesTrials()

Lists the trials associated with a study.


    public
                listProjectsLocationsStudiesTrials(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListTrialsResponse

(trials.listProjectsLocationsStudiesTrials)

Parameters

$parent : string: Required. The name of the study that the trial belongs to.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListTrialsResponse —

stop()

Stops a trial. (trials.stop)


    public
                stop(string $name, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1StopTrialRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial

Parameters

$name : string: Required. The trial name.
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1StopTrialRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Trial —

suggest()

Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. (trials.suggest)


    public
                suggest(string $parent, Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1SuggestTrialsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

Parameters

$parent : string: Required. The name of the study that the trial belongs to.
$postBody : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1SuggestTrialsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —