Class protos.google.ai.generativelanguage.v1beta.Hyperparameters (2.6.0)

Represents a Hyperparameters.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1beta.IHyperparameters);

Constructs a new Hyperparameters.

Parameter
Name Description
properties IHyperparameters

Properties to set

Properties

_batchSize

public _batchSize?: "batchSize";

Hyperparameters _batchSize.

_epochCount

public _epochCount?: "epochCount";

Hyperparameters _epochCount.

batchSize

public batchSize?: (number|null);

Hyperparameters batchSize.

epochCount

public epochCount?: (number|null);

Hyperparameters epochCount.

learningRate

public learningRate?: (number|null);

Hyperparameters learningRate.

learningRateMultiplier

public learningRateMultiplier?: (number|null);

Hyperparameters learningRateMultiplier.

learningRateOption

public learningRateOption?: ("learningRate"|"learningRateMultiplier");

Hyperparameters learningRateOption.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.IHyperparameters): google.ai.generativelanguage.v1beta.Hyperparameters;

Creates a new Hyperparameters instance using the specified properties.

Parameter
Name Description
properties IHyperparameters

Properties to set

Returns
Type Description
Hyperparameters

Hyperparameters instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.Hyperparameters;

Decodes a Hyperparameters message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Hyperparameters

Hyperparameters

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.Hyperparameters;

Decodes a Hyperparameters message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Hyperparameters

Hyperparameters

encode(message, writer)

public static encode(message: google.ai.generativelanguage.v1beta.IHyperparameters, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Hyperparameters message. Does not implicitly messages.

Parameters
Name Description
message IHyperparameters

Hyperparameters message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.ai.generativelanguage.v1beta.IHyperparameters, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Hyperparameters message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IHyperparameters

Hyperparameters message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.ai.generativelanguage.v1beta.Hyperparameters;

Creates a Hyperparameters message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
Hyperparameters

Hyperparameters

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Hyperparameters

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Hyperparameters to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ai.generativelanguage.v1beta.Hyperparameters, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Hyperparameters message. Also converts values to other types if specified.

Parameters
Name Description
message Hyperparameters

Hyperparameters

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Hyperparameters message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not