Class RougeSpec (3.42.0)

public final class RougeSpec extends GeneratedMessageV3 implements RougeSpecOrBuilder

Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.

Protobuf type google.cloud.aiplatform.v1beta1.RougeSpec

Implements

RougeSpecOrBuilder

Static Fields

ROUGE_TYPE_FIELD_NUMBER

public static final int ROUGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SPLIT_SUMMARIES_FIELD_NUMBER

public static final int SPLIT_SUMMARIES_FIELD_NUMBER
Field Value
TypeDescription
int

USE_STEMMER_FIELD_NUMBER

public static final int USE_STEMMER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RougeSpec getDefaultInstance()
Returns
TypeDescription
RougeSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RougeSpec.Builder newBuilder()
Returns
TypeDescription
RougeSpec.Builder

newBuilder(RougeSpec prototype)

public static RougeSpec.Builder newBuilder(RougeSpec prototype)
Parameter
NameDescription
prototypeRougeSpec
Returns
TypeDescription
RougeSpec.Builder

parseDelimitedFrom(InputStream input)

public static RougeSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RougeSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RougeSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RougeSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RougeSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RougeSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RougeSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RougeSpec> parser()
Returns
TypeDescription
Parser<RougeSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RougeSpec getDefaultInstanceForType()
Returns
TypeDescription
RougeSpec

getParserForType()

public Parser<RougeSpec> getParserForType()
Returns
TypeDescription
Parser<RougeSpec>
Overrides

getRougeType()

public String getRougeType()

Optional. Supported rouge types are rougen[1-9], rougeL and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The rougeType.

getRougeTypeBytes()

public ByteString getRougeTypeBytes()

Optional. Supported rouge types are rougen[1-9], rougeL and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for rougeType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSplitSummaries()

public boolean getSplitSummaries()

Optional. Whether to split summaries while using rougeLsum.

bool split_summaries = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The splitSummaries.

getUseStemmer()

public boolean getUseStemmer()

Optional. Whether to use stemmer to compute rouge score.

bool use_stemmer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The useStemmer.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RougeSpec.Builder newBuilderForType()
Returns
TypeDescription
RougeSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RougeSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RougeSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RougeSpec.Builder toBuilder()
Returns
TypeDescription
RougeSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException