org.tensorflow.framework

Class GradientDef

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.framework.GradientDef

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, GradientDefOrBuilder

public final class GradientDef
extends com.google.protobuf.GeneratedMessageV3
implements GradientDefOrBuilder

 GradientDef defines the gradient function of a function defined in
 a function library.
 A gradient function g (specified by gradient_func) for a function f
 (specified by function_name) must follow the following:
 The function 'f' must be a numerical function which takes N inputs
 and produces M outputs. Its gradient function 'g', which is a
 function taking N + M inputs and produces N outputs.
 I.e. if we have
    (y1, y2, ..., y_M) = f(x1, x2, ..., x_N),
 then, g is
    (dL/dx1, dL/dx2, ..., dL/dx_N) = g(x1, x2, ..., x_N,
                                      dL/dy1, dL/dy2, ..., dL/dy_M),
 where L is a scalar-value function of (x1, x2, ..., xN) (e.g., the
 loss function). dL/dx_i is the partial derivative of L with respect
 to x_i.
 

Protobuf type tensorflow.GradientDef

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GradientDef.Builder GradientDef defines the gradient function of a function defined in a function library.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FUNCTION_NAME_FIELD_NUMBER
static int	GRADIENT_FUNC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static GradientDef	getDefaultInstance()
GradientDef	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getFunctionName() The function name.
com.google.protobuf.ByteString	getFunctionNameBytes() The function name.
java.lang.String	getGradientFunc() The gradient function's name.
com.google.protobuf.ByteString	getGradientFuncBytes() The gradient function's name.
com.google.protobuf.Parser<GradientDef>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GradientDef.Builder	newBuilder()
static GradientDef.Builder	newBuilder(GradientDef prototype)
GradientDef.Builder	newBuilderForType()
protected GradientDef.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GradientDef	parseDelimitedFrom(java.io.InputStream input)
static GradientDef	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GradientDef	parseFrom(byte[] data)
static GradientDef	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GradientDef	parseFrom(java.nio.ByteBuffer data)
static GradientDef	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GradientDef	parseFrom(com.google.protobuf.ByteString data)
static GradientDef	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GradientDef	parseFrom(com.google.protobuf.CodedInputStream input)
static GradientDef	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GradientDef	parseFrom(java.io.InputStream input)
static GradientDef	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GradientDef>	parser()
GradientDef.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER

See Also:

Constant Field Values

GRADIENT_FUNC_FIELD_NUMBER

public static final int GRADIENT_FUNC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFunctionName

public java.lang.String getFunctionName()

 The function name.
 

string function_name = 1;

Specified by:

getFunctionName in interface GradientDefOrBuilder

Returns:

The functionName.

getFunctionNameBytes

public com.google.protobuf.ByteString getFunctionNameBytes()

 The function name.
 

string function_name = 1;

Specified by:

getFunctionNameBytes in interface GradientDefOrBuilder

Returns:

The bytes for functionName.

getGradientFunc

public java.lang.String getGradientFunc()

 The gradient function's name.
 

string gradient_func = 2;

Specified by:

getGradientFunc in interface GradientDefOrBuilder

Returns:

The gradientFunc.

getGradientFuncBytes

public com.google.protobuf.ByteString getGradientFuncBytes()

 The gradient function's name.
 

string gradient_func = 2;

Specified by:

getGradientFuncBytes in interface GradientDefOrBuilder

Returns:

The bytes for gradientFunc.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GradientDef parseFrom(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(java.io.InputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GradientDef parseFrom(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GradientDef parseDelimitedFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GradientDef parseDelimitedFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GradientDef parseFrom(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GradientDef parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public GradientDef.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GradientDef.Builder newBuilder()

newBuilder

public static GradientDef.Builder newBuilder(GradientDef prototype)

toBuilder

public GradientDef.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GradientDef.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GradientDef getDefaultInstance()

parser

public static com.google.protobuf.Parser<GradientDef> parser()

getParserForType

public com.google.protobuf.Parser<GradientDef> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GradientDef getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder