Google Cloud Ai Platform V1 Client - Class SupervisedTuningDataStats (1.31.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SupervisedTuningDataStats.

Tuning data statistics for Supervised Tuning.

Generated from protobuf message google.cloud.aiplatform.v1.SupervisedTuningDataStats

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ tuning_dataset_example_count int|string

Output only. Number of examples in the tuning dataset.
↳ total_tuning_character_count int|string

Output only. Number of tuning characters in the tuning dataset.
↳ total_billable_character_count int|string

Output only. Number of billable characters in the tuning dataset.
↳ total_billable_token_count int|string

Output only. Number of billable tokens in the tuning dataset.
↳ tuning_step_count int|string

Output only. Number of tuning steps for this Tuning Job.
↳ user_input_token_distribution SupervisedTuningDatasetDistribution

Output only. Dataset distributions for the user input tokens.
↳ user_output_token_distribution SupervisedTuningDatasetDistribution

Output only. Dataset distributions for the user output tokens.
↳ user_message_per_example_distribution SupervisedTuningDatasetDistribution

Output only. Dataset distributions for the messages per example.
↳ user_dataset_examples array<Content>

Output only. Sample user messages in the training dataset uri.
↳ total_truncated_example_count int|string

Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
↳ truncated_example_indices array

Output only. A partial sample of the indices (starting from 1) of the dropped examples.
↳ dropped_example_reasons array

Output only. For each index in truncated_example_indices, the user-facing reason why the example was dropped.

getTuningDatasetExampleCount

Output only. Number of examples in the tuning dataset.

Returns
Type Description
int|string

setTuningDatasetExampleCount

Output only. Number of examples in the tuning dataset.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalTuningCharacterCount

Output only. Number of tuning characters in the tuning dataset.

Returns
Type Description
int|string

setTotalTuningCharacterCount

Output only. Number of tuning characters in the tuning dataset.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalBillableCharacterCount

Output only. Number of billable characters in the tuning dataset.

Returns
Type Description
int|string

setTotalBillableCharacterCount

Output only. Number of billable characters in the tuning dataset.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalBillableTokenCount

Output only. Number of billable tokens in the tuning dataset.

Returns
Type Description
int|string

setTotalBillableTokenCount

Output only. Number of billable tokens in the tuning dataset.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTuningStepCount

Output only. Number of tuning steps for this Tuning Job.

Returns
Type Description
int|string

setTuningStepCount

Output only. Number of tuning steps for this Tuning Job.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getUserInputTokenDistribution

Output only. Dataset distributions for the user input tokens.

Returns
Type Description
SupervisedTuningDatasetDistribution|null

hasUserInputTokenDistribution

clearUserInputTokenDistribution

setUserInputTokenDistribution

Output only. Dataset distributions for the user input tokens.

Parameter
Name Description
var SupervisedTuningDatasetDistribution
Returns
Type Description
$this

getUserOutputTokenDistribution

Output only. Dataset distributions for the user output tokens.

Returns
Type Description
SupervisedTuningDatasetDistribution|null

hasUserOutputTokenDistribution

clearUserOutputTokenDistribution

setUserOutputTokenDistribution

Output only. Dataset distributions for the user output tokens.

Parameter
Name Description
var SupervisedTuningDatasetDistribution
Returns
Type Description
$this

getUserMessagePerExampleDistribution

Output only. Dataset distributions for the messages per example.

Returns
Type Description
SupervisedTuningDatasetDistribution|null

hasUserMessagePerExampleDistribution

clearUserMessagePerExampleDistribution

setUserMessagePerExampleDistribution

Output only. Dataset distributions for the messages per example.

Parameter
Name Description
var SupervisedTuningDatasetDistribution
Returns
Type Description
$this

getUserDatasetExamples

Output only. Sample user messages in the training dataset uri.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setUserDatasetExamples

Output only. Sample user messages in the training dataset uri.

Parameter
Name Description
var array<Content>
Returns
Type Description
$this

getTotalTruncatedExampleCount

Output only. The number of examples in the dataset that have been dropped.

An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.

Returns
Type Description
int|string

setTotalTruncatedExampleCount

Output only. The number of examples in the dataset that have been dropped.

An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTruncatedExampleIndices

Output only. A partial sample of the indices (starting from 1) of the dropped examples.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTruncatedExampleIndices

Output only. A partial sample of the indices (starting from 1) of the dropped examples.

Parameter
Name Description
var int[]|string[]|Google\Protobuf\Internal\RepeatedField
Returns
Type Description
$this

getDroppedExampleReasons

Output only. For each index in truncated_example_indices, the user-facing reason why the example was dropped.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDroppedExampleReasons

Output only. For each index in truncated_example_indices, the user-facing reason why the example was dropped.

Parameter
Name Description
var string[]
Returns
Type Description
$this