Warning: This API is deprecated and will be removed in a future
version of TensorFlow after
the replacement is stable.
Gather
Stay organized with collections
Save and categorize content based on your preferences.
Gather slices from `params` axis `axis` according to `indices`.
`indices` must be an integer tensor of any dimension (usually 0-D or 1-D).
Produces an output tensor with shape `params.shape[:axis] +
indices.shape[batch_dims:] + params.shape[axis + 1:]` where:
# Scalar indices (output is rank(params) - 1).
output[a_0, ..., a_n, b_0, ..., b_n] =
params[a_0, ..., a_n, indices, b_0, ..., b_n]
# Vector indices (output is rank(params)).
output[a_0, ..., a_n, i, b_0, ..., b_n] =
params[a_0, ..., a_n, indices[i], b_0, ..., b_n]
# Higher rank indices (output is rank(params) + rank(indices) - 1).
output[a_0, ..., a_n, i, ..., j, b_0, ... b_n] =
params[a_0, ..., a_n, indices[i, ..., j], b_0, ..., b_n]
Note that on CPU, if an out of bound index is found, an error is returned.
On GPU, if an out of bound index is found, a 0 is stored in the
corresponding output value.
See also `tf.batch_gather` and tf.gather_nd
.
Public Methods
Output<T>
|
asOutput()
Returns the symbolic handle of a tensor.
|
static
Gather.Options
|
|
static
<T, U extends Number, V extends Number>
Gather<T>
|
|
Output<T>
|
output()
Values from `params` gathered from indices given by `indices`, with
shape `params.shape[:axis] + indices.shape + params.shape[axis + 1:]`.
|
Inherited Methods
From class
java.lang.Object
boolean
|
equals(Object arg0)
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
Public Methods
public
Output<T>
asOutput
()
Returns the symbolic handle of a tensor.
Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.
Factory method to create a class wrapping a new Gather operation.
Parameters
scope |
current scope |
params |
The tensor from which to gather values. Must be at least rank
`axis + 1`. |
indices |
Index tensor. Must be in range `[0, params.shape[axis])`. |
axis |
The axis in `params` to gather `indices` from. Defaults to the first
dimension. Supports negative indexes. |
options |
carries optional attributes values |
public
Output<T>
output
()
Values from `params` gathered from indices given by `indices`, with
shape `params.shape[:axis] + indices.shape + params.shape[axis + 1:]`.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-02-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-02-12 UTC."],[],[],null,["# Gather\n\npublic final class **Gather** \nGather slices from \\`params\\` axis \\`axis\\` according to \\`indices\\`.\n\n\n\\`indices\\` must be an integer tensor of any dimension (usually 0-D or 1-D).\nProduces an output tensor with shape \\`params.shape\\[:axis\\] +\nindices.shape\\[batch_dims:\\] + params.shape\\[axis + 1:\\]\\` where: \n\n # Scalar indices (output is rank(params) - 1).\n output[a_0, ..., a_n, b_0, ..., b_n] =\n params[a_0, ..., a_n, indices, b_0, ..., b_n]\n \n # Vector indices (output is rank(params)).\n output[a_0, ..., a_n, i, b_0, ..., b_n] =\n params[a_0, ..., a_n, indices[i], b_0, ..., b_n]\n \n # Higher rank indices (output is rank(params) + rank(indices) - 1).\n output[a_0, ..., a_n, i, ..., j, b_0, ... b_n] =\n params[a_0, ..., a_n, indices[i, ..., j], b_0, ..., b_n]\n \n\nNote that on CPU, if an out of bound index is found, an error is returned.\nOn GPU, if an out of bound index is found, a 0 is stored in the\ncorresponding output value.\n\n\nSee also \\`tf.batch_gather\\` and [`tf.gather_nd`](https://www.tensorflow.org/api_docs/python/tf/gather_nd).\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n### Nested Classes\n\n|-------|---|---|--------------------------------------------------------------------------------|\n| class | [Gather.Options](/api_docs/java/org/tensorflow/op/core/Gather.Options) || Optional attributes for [Gather](/api_docs/java/org/tensorflow/op/core/Gather) |\n\n### Public Methods\n\n|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [asOutput](/api_docs/java/org/tensorflow/op/core/Gather#asOutput())() Returns the symbolic handle of a tensor. |\n| static [Gather.Options](/api_docs/java/org/tensorflow/op/core/Gather.Options) | [batchDims](/api_docs/java/org/tensorflow/op/core/Gather#batchDims(java.lang.Long))(Long batchDims) |\n| static \\\u003cT, U extends Number, V extends Number\\\u003e [Gather](/api_docs/java/org/tensorflow/op/core/Gather)\\\u003cT\\\u003e | [create](/api_docs/java/org/tensorflow/op/core/Gather#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand\u003cT\u003e,%20org.tensorflow.Operand\u003cU\u003e,%20org.tensorflow.Operand\u003cV\u003e,%20org.tensorflow.op.core.Gather.Options...))([Scope](/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e params, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cU\\\u003e indices, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cV\\\u003e axis, [Options...](/api_docs/java/org/tensorflow/op/core/Gather.Options) options) Factory method to create a class wrapping a new Gather operation. |\n| [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [output](/api_docs/java/org/tensorflow/op/core/Gather#output())() Values from \\`params\\` gathered from indices given by \\`indices\\`, with shape \\`params.shape\\[:axis\\] + indices.shape + params.shape\\[axis + 1:\\]\\`. |\n\n### Inherited Methods\n\nFrom class [org.tensorflow.op.PrimitiveOp](/api_docs/java/org/tensorflow/op/PrimitiveOp) \n\n|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| final boolean | [equals](/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |\n| final int | [hashCode](/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |\n| [Operation](/api_docs/java/org/tensorflow/Operation) | [op](/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying [Operation](/api_docs/java/org/tensorflow/Operation) |\n| final String | [toString](/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface [org.tensorflow.Operand](/api_docs/java/org/tensorflow/Operand) \n\n|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|\n| abstract [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [asOutput](/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |\n\nPublic Methods\n--------------\n\n#### public [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e\n**asOutput**\n()\n\nReturns the symbolic handle of a tensor.\n\nInputs to TensorFlow operations are outputs of another TensorFlow operation. This method is\nused to obtain a symbolic handle that represents the computation of the input.\n\n\u003cbr /\u003e\n\n#### public static [Gather.Options](/api_docs/java/org/tensorflow/op/core/Gather.Options)\n**batchDims**\n(Long batchDims)\n\n\u003cbr /\u003e\n\n#### public static [Gather](/api_docs/java/org/tensorflow/op/core/Gather)\\\u003cT\\\u003e\n**create**\n([Scope](/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e params, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cU\\\u003e indices, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cV\\\u003e axis, [Options...](/api_docs/java/org/tensorflow/op/core/Gather.Options) options)\n\nFactory method to create a class wrapping a new Gather operation. \n\n##### Parameters\n\n| scope | current scope |\n| params | The tensor from which to gather values. Must be at least rank \\`axis + 1\\`. |\n| indices | Index tensor. Must be in range \\`\\[0, params.shape\\[axis\\])\\`. |\n| axis | The axis in \\`params\\` to gather \\`indices\\` from. Defaults to the first dimension. Supports negative indexes. |\n| options | carries optional attributes values |\n|---------|----------------------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- a new instance of Gather \n\n#### public [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e\n**output**\n()\n\nValues from \\`params\\` gathered from indices given by \\`indices\\`, with\nshape \\`params.shape\\[:axis\\] + indices.shape + params.shape\\[axis + 1:\\]\\`."]]