Class VeoHyperParameters.Builder (3.100.0)

public static final class VeoHyperParameters.Builder extends GeneratedMessage.Builder<VeoHyperParameters.Builder> implements VeoHyperParametersOrBuilder

Hyperparameters for Veo.

Protobuf type google.cloud.aiplatform.v1beta1.VeoHyperParameters

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public VeoHyperParameters build()
Returns
Type Description
VeoHyperParameters

buildPartial()

public VeoHyperParameters buildPartial()
Returns
Type Description
VeoHyperParameters

clear()

public VeoHyperParameters.Builder clear()
Returns
Type Description
VeoHyperParameters.Builder
Overrides

clearAdapterSize()

public VeoHyperParameters.Builder clearAdapterSize()

Optional. The adapter size for LoRA tuning.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.AdapterSize adapter_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

clearEpochCount()

public VeoHyperParameters.Builder clearEpochCount()

Optional. Number of complete passes the model makes over the entire training dataset during training.

int64 epoch_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

clearLearningRateMultiplier()

public VeoHyperParameters.Builder clearLearningRateMultiplier()

Optional. Multiplier for adjusting the default learning rate.

double learning_rate_multiplier = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

clearTuningSpeed()

public VeoHyperParameters.Builder clearTuningSpeed()

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

clearTuningTask()

public VeoHyperParameters.Builder clearTuningTask()

Optional. The tuning task. Either I2V or T2V.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningTask tuning_task = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

clearVeoDataMixtureRatio()

public VeoHyperParameters.Builder clearVeoDataMixtureRatio()

Optional. The ratio of Google internal dataset to use in the training mixture, in range of [0, 1). If 0.2, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.

optional double veo_data_mixture_ratio = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

getAdapterSize()

public VeoHyperParameters.AdapterSize getAdapterSize()

Optional. The adapter size for LoRA tuning.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.AdapterSize adapter_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.AdapterSize

The adapterSize.

getAdapterSizeValue()

public int getAdapterSizeValue()

Optional. The adapter size for LoRA tuning.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.AdapterSize adapter_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for adapterSize.

getDefaultInstanceForType()

public VeoHyperParameters getDefaultInstanceForType()
Returns
Type Description
VeoHyperParameters

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEpochCount()

public long getEpochCount()

Optional. Number of complete passes the model makes over the entire training dataset during training.

int64 epoch_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The epochCount.

getLearningRateMultiplier()

public double getLearningRateMultiplier()

Optional. Multiplier for adjusting the default learning rate.

double learning_rate_multiplier = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The learningRateMultiplier.

getTuningSpeed()

public VeoHyperParameters.TuningSpeed getTuningSpeed()

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Returns
Type Description
VeoHyperParameters.TuningSpeed

The tuningSpeed.

getTuningSpeedValue()

public int getTuningSpeedValue()

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Returns
Type Description
int

The enum numeric value on the wire for tuningSpeed.

getTuningTask()

public VeoHyperParameters.TuningTask getTuningTask()

Optional. The tuning task. Either I2V or T2V.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningTask tuning_task = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VeoHyperParameters.TuningTask

The tuningTask.

getTuningTaskValue()

public int getTuningTaskValue()

Optional. The tuning task. Either I2V or T2V.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningTask tuning_task = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for tuningTask.

getVeoDataMixtureRatio()

public double getVeoDataMixtureRatio()

Optional. The ratio of Google internal dataset to use in the training mixture, in range of [0, 1). If 0.2, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.

optional double veo_data_mixture_ratio = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The veoDataMixtureRatio.

hasTuningSpeed()

public boolean hasTuningSpeed()

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Returns
Type Description
boolean

Whether the tuningSpeed field is set.

hasVeoDataMixtureRatio()

public boolean hasVeoDataMixtureRatio()

Optional. The ratio of Google internal dataset to use in the training mixture, in range of [0, 1). If 0.2, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.

optional double veo_data_mixture_ratio = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the veoDataMixtureRatio field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VeoHyperParameters other)

public VeoHyperParameters.Builder mergeFrom(VeoHyperParameters other)
Parameter
Name Description
other VeoHyperParameters
Returns
Type Description
VeoHyperParameters.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VeoHyperParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VeoHyperParameters.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VeoHyperParameters.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VeoHyperParameters.Builder
Overrides

setAdapterSize(VeoHyperParameters.AdapterSize value)

public VeoHyperParameters.Builder setAdapterSize(VeoHyperParameters.AdapterSize value)

Optional. The adapter size for LoRA tuning.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.AdapterSize adapter_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VeoHyperParameters.AdapterSize

The adapterSize to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setAdapterSizeValue(int value)

public VeoHyperParameters.Builder setAdapterSizeValue(int value)

Optional. The adapter size for LoRA tuning.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.AdapterSize adapter_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for adapterSize to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setEpochCount(long value)

public VeoHyperParameters.Builder setEpochCount(long value)

Optional. Number of complete passes the model makes over the entire training dataset during training.

int64 epoch_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The epochCount to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setLearningRateMultiplier(double value)

public VeoHyperParameters.Builder setLearningRateMultiplier(double value)

Optional. Multiplier for adjusting the default learning rate.

double learning_rate_multiplier = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The learningRateMultiplier to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setTuningSpeed(VeoHyperParameters.TuningSpeed value)

public VeoHyperParameters.Builder setTuningSpeed(VeoHyperParameters.TuningSpeed value)

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Parameter
Name Description
value VeoHyperParameters.TuningSpeed

The tuningSpeed to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setTuningSpeedValue(int value)

public VeoHyperParameters.Builder setTuningSpeedValue(int value)

The speed of the tuning job. Only supported for Veo 3.0 models.

optional .google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningSpeed tuning_speed = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for tuningSpeed to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setTuningTask(VeoHyperParameters.TuningTask value)

public VeoHyperParameters.Builder setTuningTask(VeoHyperParameters.TuningTask value)

Optional. The tuning task. Either I2V or T2V.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningTask tuning_task = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VeoHyperParameters.TuningTask

The tuningTask to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setTuningTaskValue(int value)

public VeoHyperParameters.Builder setTuningTaskValue(int value)

Optional. The tuning task. Either I2V or T2V.

.google.cloud.aiplatform.v1beta1.VeoHyperParameters.TuningTask tuning_task = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for tuningTask to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.

setVeoDataMixtureRatio(double value)

public VeoHyperParameters.Builder setVeoDataMixtureRatio(double value)

Optional. The ratio of Google internal dataset to use in the training mixture, in range of [0, 1). If 0.2, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.

optional double veo_data_mixture_ratio = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The veoDataMixtureRatio to set.

Returns
Type Description
VeoHyperParameters.Builder

This builder for chaining.