# tensorflow::ops::ApproxTopK

`#include <nn_ops.h>`

Returns min/max k values and their indices of the input operand in an approximate manner.

## Summary

See <https://arxiv.org/abs/2206.14286> for the algorithm details. This op is only optimized on TPU currently.

Args:

- scope: A [Scope](https://www.tensorflow.org/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- input: Array to search. Must be at least 1-D of the floating type
- k: Specifies the number of min/max-k.

<br />

Optional attributes (see `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs`):

- reduction_dimension: Integer dimension along which to search. Default: -1.
- recall_target: Recall target for the approximation. [Range](https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/range#classtensorflow_1_1ops_1_1_range) in (0,1\]
- is_max_k: When true, computes max-k; otherwise computes min-k.
- reduction_input_size_override: When set to a positive value, it overrides the size determined by `input[reduction_dim]` for evaluating the recall. This option is useful when the given `input` is only a subset of the overall computation in SPMD or distributed pipelines, where the true input size cannot be deferred by the `input` shape.
- aggregate_to_topk: When true, aggregates approximate results to top-k. When false, returns the approximate results. The number of the approximate results is implementation defined and is greater equals to the specified `k`.

<br />

Returns:

- `https://www.tensorflow.org/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` values: The min/max k values along the `reduction_dimension` of the `input` operand. The dimension are the same as the `input` operand except for the `reduction_dimension`: when `aggregate_to_topk` is true, the reduction dimension is `k`; otherwise, it is greater equals to `k` where the size is implementation-defined.
- `https://www.tensorflow.org/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` indices: The indices of `values` along the `reduction_dimension` of the `input` operand.

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1ad907e075d285236d3a304c74656f3fce(const ::https://www.tensorflow.org/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input input, int64 k)` ||
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1ad1fbdbeaf88943d4459ab5473a6d083b(const ::https://www.tensorflow.org/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input input, int64 k, const https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a2b62da2738c0559689c4d9fd8ada1247` | `::https://www.tensorflow.org/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1af62886f2c295b35d192005c4ccb87e0b` | `https://www.tensorflow.org/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a499ea415612ccef8b57503158853a0f6` | `::https://www.tensorflow.org/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a1474aabf2f67851f27f4ec47c14c75e3(bool x)` | `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a19ea77e75970e6077b85e94cecfb56ed(bool x)` | `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a0acab585fe4e60ee0fa83e5244b96e0d(float x)` | `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a3c89b1c3608339b0b5fbb4c7e3f4d31b(int64 x)` | `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs` |
| `https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k_1a28cae1ddf7876a401792dd5242202f82(int64 x)` | `https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs#structtensorflow_1_1ops_1_1_approx_top_k_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ApproxTopK::Attrs](https://www.tensorflow.org/api_docs/cc/struct/tensorflow/ops/approx-top-k/attrs) | Optional attribute setters for [ApproxTopK](https://www.tensorflow.org/api_docs/cc/class/tensorflow/ops/approx-top-k#classtensorflow_1_1ops_1_1_approx_top_k). |

## Public attributes

### indices

```
::tensorflow::Output indices
```

### operation

```
Operation operation
```

### values

```
::tensorflow::Output values
```

## Public functions

### ApproxTopK

```
 ApproxTopK(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input input,
  int64 k
)
```

### ApproxTopK

```
 ApproxTopK(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input input,
  int64 k,
  const ApproxTopK::Attrs & attrs
)
```

## Public static functions

### AggregateToTopk

```
Attrs AggregateToTopk(
  bool x
)
```

### IsMaxK

```
Attrs IsMaxK(
  bool x
)
```

### RecallTarget

```
Attrs RecallTarget(
  float x
)
```

### ReductionDimension

```
Attrs ReductionDimension(
  int64 x
)
```

### ReductionInputSizeOverride

```
Attrs ReductionInputSizeOverride(
  int64 x
)
```