TopK
Stay organized with collections
Save and categorize content based on your preferences.
Finds values and indices of the `k` largest elements for the last dimension.
If the input is a vector (rank-1), finds the `k` largest entries in the vector
and outputs their values and indices as vectors. Thus `values[j]` is the
`j`-th largest entry in `input`, and its index is `indices[j]`.
For matrices (resp. higher rank input), computes the top `k` entries in each
row (resp. vector along the last dimension). Thus,
values.shape = indices.shape = input.shape[:-1] + [k]
If two elements are equal, the lower-index element appears first.
Constants
| String |
OP_NAME |
The name of this op, as known by TensorFlow core engine |
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()
|
Constants
public
static
final
String
OP_NAME
The name of this op, as known by TensorFlow core engine
Constant Value:
"TopKV2"
Public Methods
Factory method to create a class wrapping a new TopK operation.
Parameters
| scope |
current scope |
| input |
1-D or higher with last dimension at least `k`. |
| k |
0-D. Number of top elements to look for along the last dimension (along each
row for matrices). |
| options |
carries optional attributes values |
The indices of `values` within the last dimension of `input`.
public
static
TopK.Options
sorted
(Boolean sorted)
Parameters
| sorted |
If true the resulting `k` elements will be sorted by the values in
descending order.
|
public
Output<T>
values
()
The `k` largest elements along each last dimensional slice.
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 2021-11-29 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 2021-11-29 UTC."],[],[],null,["# TopK\n\npublic final class **TopK** \nFinds values and indices of the \\`k\\` largest elements for the last dimension.\n\n\nIf the input is a vector (rank-1), finds the \\`k\\` largest entries in the vector\nand outputs their values and indices as vectors. Thus \\`values\\[j\\]\\` is the\n\\`j\\`-th largest entry in \\`input\\`, and its index is \\`indices\\[j\\]\\`.\n\n\nFor matrices (resp. higher rank input), computes the top \\`k\\` entries in each\nrow (resp. vector along the last dimension). Thus,\n\n\nvalues.shape = indices.shape = input.shape\\[:-1\\] + \\[k\\]\n\n\nIf two elements are equal, the lower-index element appears first.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n### Nested Classes\n\n|-------|---|---|------------------------------------------------------------------------------|\n| class | [TopK.Options](/jvm/api_docs/java/org/tensorflow/op/nn/TopK.Options) || Optional attributes for [TopK](/jvm/api_docs/java/org/tensorflow/op/nn/TopK) |\n\n### Constants\n\n|--------|-----------------------------------------------------------------|---------------------------------------------------------|\n| String | [OP_NAME](/jvm/api_docs/java/org/tensorflow/op/nn/TopK#OP_NAME) | The name of this op, as known by TensorFlow core engine |\n\n### Public Methods\n\n|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static \\\u003cT extends [TNumber](/jvm/api_docs/java/org/tensorflow/types/family/TNumber)\\\u003e [TopK](/jvm/api_docs/java/org/tensorflow/op/nn/TopK)\\\u003cT\\\u003e | [create](/jvm/api_docs/java/org/tensorflow/op/nn/TopK#create(org.tensorflow.op.Scope, org.tensorflow.Operand\u003cT\u003e, org.tensorflow.Operand\u003corg.tensorflow.types.TInt32\u003e, org.tensorflow.op.nn.TopK.Options...))([Scope](/jvm/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/jvm/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e input, [Operand](/jvm/api_docs/java/org/tensorflow/Operand)\\\u003c[TInt32](/jvm/api_docs/java/org/tensorflow/types/TInt32)\\\u003e k, [Options...](/jvm/api_docs/java/org/tensorflow/op/nn/TopK.Options) options) Factory method to create a class wrapping a new TopK operation. |\n| [Output](/jvm/api_docs/java/org/tensorflow/Output)\\\u003c[TInt32](/jvm/api_docs/java/org/tensorflow/types/TInt32)\\\u003e | [indices](/jvm/api_docs/java/org/tensorflow/op/nn/TopK#indices())() The indices of \\`values\\` within the last dimension of \\`input\\`. |\n| static [TopK.Options](/jvm/api_docs/java/org/tensorflow/op/nn/TopK.Options) | [sorted](/jvm/api_docs/java/org/tensorflow/op/nn/TopK#sorted(java.lang.Boolean))(Boolean sorted) |\n| [Output](/jvm/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [values](/jvm/api_docs/java/org/tensorflow/op/nn/TopK#values())() The \\`k\\` largest elements along each last dimensional slice. |\n\n### Inherited Methods\n\nFrom class [org.tensorflow.op.RawOp](/jvm/api_docs/java/org/tensorflow/op/RawOp) \n\n|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| final boolean | [equals](/jvm/api_docs/java/org/tensorflow/op/RawOp#equals(java.lang.Object))(Object obj) |\n| final int | [hashCode](/jvm/api_docs/java/org/tensorflow/op/RawOp#hashCode())() |\n| [Operation](/jvm/api_docs/java/org/tensorflow/Operation) | [op](/jvm/api_docs/java/org/tensorflow/op/RawOp#op())() Return this unit of computation as a single [Operation](/jvm/api_docs/java/org/tensorflow/Operation). |\n| final String | [toString](/jvm/api_docs/java/org/tensorflow/op/RawOp#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.op.Op](/jvm/api_docs/java/org/tensorflow/op/Op) \n\n|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [ExecutionEnvironment](/jvm/api_docs/java/org/tensorflow/ExecutionEnvironment) | [env](/jvm/api_docs/java/org/tensorflow/op/Op#env())() Return the execution environment this op was created in. |\n| abstract [Operation](/jvm/api_docs/java/org/tensorflow/Operation) | [op](/jvm/api_docs/java/org/tensorflow/op/Op#op())() Return this unit of computation as a single [Operation](/jvm/api_docs/java/org/tensorflow/Operation). |\n\nConstants\n---------\n\n#### public static final String\n**OP_NAME**\n\nThe name of this op, as known by TensorFlow core engine \nConstant Value: \"TopKV2\"\n\nPublic Methods\n--------------\n\n#### public static [TopK](/jvm/api_docs/java/org/tensorflow/op/nn/TopK)\\\u003cT\\\u003e\n**create**\n([Scope](/jvm/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/jvm/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e input, [Operand](/jvm/api_docs/java/org/tensorflow/Operand)\\\u003c[TInt32](/jvm/api_docs/java/org/tensorflow/types/TInt32)\\\u003e k, [Options...](/jvm/api_docs/java/org/tensorflow/op/nn/TopK.Options) options)\n\nFactory method to create a class wrapping a new TopK operation. \n\n##### Parameters\n\n| scope | current scope |\n| input | 1-D or higher with last dimension at least \\`k\\`. |\n| k | 0-D. Number of top elements to look for along the last dimension (along each row for matrices). |\n| options | carries optional attributes values |\n|---------|-------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- a new instance of TopK \n\n#### public [Output](/jvm/api_docs/java/org/tensorflow/Output)\\\u003c[TInt32](/jvm/api_docs/java/org/tensorflow/types/TInt32)\\\u003e\n**indices**\n()\n\nThe indices of \\`values\\` within the last dimension of \\`input\\`. \n\n#### public static [TopK.Options](/jvm/api_docs/java/org/tensorflow/op/nn/TopK.Options)\n**sorted**\n(Boolean sorted)\n\n\u003cbr /\u003e\n\n##### Parameters\n\n| sorted | If true the resulting \\`k\\` elements will be sorted by the values in descending order. |\n|--------|----------------------------------------------------------------------------------------|\n\n#### public [Output](/jvm/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e\n**values**\n()\n\nThe \\`k\\` largest elements along each last dimensional slice."]]
