From fb2f2865c64ed7bc6a1ae4b9335d122dc1c5e5b0 Mon Sep 17 00:00:00 2001 From: ChaiBapchya Date: Mon, 21 Oct 2019 13:26:22 -0700 Subject: [PATCH] fix doc for topk --- src/operator/tensor/ordering_op.cc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/operator/tensor/ordering_op.cc b/src/operator/tensor/ordering_op.cc index 58c98f3a380c..e36416114e31 100644 --- a/src/operator/tensor/ordering_op.cc +++ b/src/operator/tensor/ordering_op.cc @@ -35,7 +35,10 @@ DMLC_REGISTER_PARAMETER(ArgSortParam); NNVM_REGISTER_OP(topk) .add_alias("_npx_topk") -.describe(R"code(Returns the top *k* elements in an input array along the given axis. +.describe(R"code(Returns the indices of the top *k* elements in an input array along the given + axis (by default). + If ret_type is set to 'value' returns the value of top *k* elements (instead of indices). + In case of ret_type = 'both', both value and index would be returned. The returned elements will be sorted. Examples::