org.tensorflow.framework

Class GradientDef

java.lang.Object

org.nd4j.shade.protobuf.AbstractMessageLite

org.nd4j.shade.protobuf.AbstractMessage

org.nd4j.shade.protobuf.GeneratedMessageV3

org.tensorflow.framework.GradientDef

All Implemented Interfaces:

Serializable, org.nd4j.shade.protobuf.Message, org.nd4j.shade.protobuf.MessageLite, org.nd4j.shade.protobuf.MessageLiteOrBuilder, org.nd4j.shade.protobuf.MessageOrBuilder, GradientDefOrBuilder

public final class GradientDef
extends org.nd4j.shade.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 org.nd4j.shade.protobuf.GeneratedMessageV3

org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable, org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class org.nd4j.shade.protobuf.AbstractMessageLite

org.nd4j.shade.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 org.nd4j.shade.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class org.nd4j.shade.protobuf.AbstractMessage

memoizedSize

Fields inherited from class org.nd4j.shade.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

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

Methods inherited from class org.nd4j.shade.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 org.nd4j.shade.protobuf.AbstractMessage

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

Methods inherited from class org.nd4j.shade.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 org.nd4j.shade.protobuf.MessageOrBuilder

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

Methods inherited from interface org.nd4j.shade.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 Object newInstance(org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class org.nd4j.shade.protobuf.GeneratedMessageV3

getUnknownFields

public final org.nd4j.shade.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface org.nd4j.shade.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class org.nd4j.shade.protobuf.GeneratedMessageV3

getDescriptor

public static final org.nd4j.shade.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class org.nd4j.shade.protobuf.GeneratedMessageV3

getFunctionName

public String getFunctionName()

 The function name.
 

string function_name = 1;

Specified by:

getFunctionName in interface GradientDefOrBuilder

getFunctionNameBytes

public org.nd4j.shade.protobuf.ByteString getFunctionNameBytes()

 The function name.
 

string function_name = 1;

Specified by:

getFunctionNameBytes in interface GradientDefOrBuilder

getGradientFunc

public String getGradientFunc()

 The gradient function's name.
 

string gradient_func = 2;

Specified by:

getGradientFunc in interface GradientDefOrBuilder

getGradientFuncBytes

public org.nd4j.shade.protobuf.ByteString getGradientFuncBytes()

 The gradient function's name.
 

string gradient_func = 2;

Specified by:

getGradientFuncBytes in interface GradientDefOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class org.nd4j.shade.protobuf.GeneratedMessageV3

writeTo

public void writeTo(org.nd4j.shade.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface org.nd4j.shade.protobuf.MessageLite

Overrides:

writeTo in class org.nd4j.shade.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface org.nd4j.shade.protobuf.MessageLite

Overrides:

getSerializedSize in class org.nd4j.shade.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.nd4j.shade.protobuf.Message

Overrides:

equals in class org.nd4j.shade.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface org.nd4j.shade.protobuf.Message

Overrides:

hashCode in class org.nd4j.shade.protobuf.AbstractMessage

parseFrom

public static GradientDef parseFrom(ByteBuffer data)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(ByteBuffer data,
                                    org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(org.nd4j.shade.protobuf.ByteString data)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(org.nd4j.shade.protobuf.ByteString data,
                                    org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(byte[] data)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(byte[] data,
                                    org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws org.nd4j.shade.protobuf.InvalidProtocolBufferException

Throws:

org.nd4j.shade.protobuf.InvalidProtocolBufferException

parseFrom

public static GradientDef parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static GradientDef parseFrom(InputStream input,
                                    org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static GradientDef parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static GradientDef parseDelimitedFrom(InputStream input,
                                             org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static GradientDef parseFrom(org.nd4j.shade.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static GradientDef parseFrom(org.nd4j.shade.protobuf.CodedInputStream input,
                                    org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public GradientDef.Builder newBuilderForType()

Specified by:

newBuilderForType in interface org.nd4j.shade.protobuf.Message

Specified by:

newBuilderForType in interface org.nd4j.shade.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 org.nd4j.shade.protobuf.Message

Specified by:

toBuilder in interface org.nd4j.shade.protobuf.MessageLite

newBuilderForType

protected GradientDef.Builder newBuilderForType(org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

getDefaultInstance

public static GradientDef getDefaultInstance()

parser

public static org.nd4j.shade.protobuf.Parser<GradientDef> parser()

getParserForType

public org.nd4j.shade.protobuf.Parser<GradientDef> getParserForType()

Specified by:

getParserForType in interface org.nd4j.shade.protobuf.Message

Specified by:

getParserForType in interface org.nd4j.shade.protobuf.MessageLite

Overrides:

getParserForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GradientDef getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageOrBuilder