public final class CustomCodeExecutionSpec extends GeneratedMessage implements CustomCodeExecutionSpecOrBuilder
Specificies a metric that is populated by evaluating user-defined Python
code.
Protobuf type google.cloud.aiplatform.v1beta1.CustomCodeExecutionSpec
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int EVALUATION_FUNCTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static CustomCodeExecutionSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static CustomCodeExecutionSpec.Builder newBuilder()
public static CustomCodeExecutionSpec.Builder newBuilder(CustomCodeExecutionSpec prototype)
public static CustomCodeExecutionSpec parseDelimitedFrom(InputStream input)
public static CustomCodeExecutionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomCodeExecutionSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static CustomCodeExecutionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomCodeExecutionSpec parseFrom(ByteString data)
public static CustomCodeExecutionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomCodeExecutionSpec parseFrom(CodedInputStream input)
public static CustomCodeExecutionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomCodeExecutionSpec parseFrom(InputStream input)
public static CustomCodeExecutionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomCodeExecutionSpec parseFrom(ByteBuffer data)
public static CustomCodeExecutionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<CustomCodeExecutionSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public CustomCodeExecutionSpec getDefaultInstanceForType()
public String getEvaluationFunction()
Required. Python function.
Expected user to define the following function, e.g.:
def evaluate(instance: dict[str, Any]) -> float:
Please include this function signature in the code snippet.
Instance is the evaluation instance, any fields populated in the instance
are available to the function as instance[field_name].
Example:
Example input:
`
instance= EvaluationInstance(
response=EvaluationInstance.InstanceData(text="The answer is 4."),
reference=EvaluationInstance.InstanceData(text="4")
)
Example converted input:
{
'response': {'text': 'The answer is 4.'},
'reference': {'text': '4'}
}
Example python function:
def evaluate(instance: dict[str, Any]) -> float:
if instance'response' == instance'reference':
return 1.0
return 0.0
CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
RPC) and Tuning Evaluation. Each line in the input jsonl file will be
converted to dict[str, Any] and passed to the evaluation function.
optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The evaluationFunction.
|
public ByteString getEvaluationFunctionBytes()
Required. Python function.
Expected user to define the following function, e.g.:
def evaluate(instance: dict[str, Any]) -> float:
Please include this function signature in the code snippet.
Instance is the evaluation instance, any fields populated in the instance
are available to the function as instance[field_name].
Example:
Example input:
`
instance= EvaluationInstance(
response=EvaluationInstance.InstanceData(text="The answer is 4."),
reference=EvaluationInstance.InstanceData(text="4")
)
Example converted input:
{
'response': {'text': 'The answer is 4.'},
'reference': {'text': '4'}
}
Example python function:
def evaluate(instance: dict[str, Any]) -> float:
if instance'response' == instance'reference':
return 1.0
return 0.0
CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
RPC) and Tuning Evaluation. Each line in the input jsonl file will be
converted to dict[str, Any] and passed to the evaluation function.
optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for evaluationFunction.
|
public Parser<CustomCodeExecutionSpec> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasEvaluationFunction()
Required. Python function.
Expected user to define the following function, e.g.:
def evaluate(instance: dict[str, Any]) -> float:
Please include this function signature in the code snippet.
Instance is the evaluation instance, any fields populated in the instance
are available to the function as instance[field_name].
Example:
Example input:
`
instance= EvaluationInstance(
response=EvaluationInstance.InstanceData(text="The answer is 4."),
reference=EvaluationInstance.InstanceData(text="4")
)
Example converted input:
{
'response': {'text': 'The answer is 4.'},
'reference': {'text': '4'}
}
Example python function:
def evaluate(instance: dict[str, Any]) -> float:
if instance'response' == instance'reference':
return 1.0
return 0.0
CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
RPC) and Tuning Evaluation. Each line in the input jsonl file will be
converted to dict[str, Any] and passed to the evaluation function.
optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the evaluationFunction field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public CustomCodeExecutionSpec.Builder newBuilderForType()
protected CustomCodeExecutionSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public CustomCodeExecutionSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
