typo in the operators docs of topk. #5826
Conversation
wplf
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5826 +/- ##
=======================================
Coverage 56.45% 56.45%
=======================================
Files 504 504
Lines 29865 29865
Branches 4484 4484
=======================================
Hits 16860 16860
Misses 12188 12188
Partials 817 817 ☔ View full report in Codecov by Sentry. |
| @@ -33047,7 +33047,7 @@ expect(node, inputs=[x, repeats], outputs=[z], name="test_tile_precomputed") | |||
| ### <a name="TopK"></a><a name="topk">**TopK**</a> | |||
|
|
|||
| Retrieve the top-K largest or smallest elements along a specified axis. Given an input tensor of | |||
| shape [a_1, a_2, ..., a_n, r] and integer argument k, return two outputs: | |||
| shape [a_1, a_2, ..., a_n] and integer argument k, return two outputs: | |||
There was a problem hiding this comment.
The documentation needs to be be fixed as well in cc files. You may look for and integer argument k, return two outputs in the code to find all the location this string appears.
There was a problem hiding this comment.
Yes, I find this typo appears in many files. Do I need to fix them all?
There was a problem hiding this comment.
For this kind of simple change, it usually works if all instances of the same sentance are fixed. The auto-generation can be skipped. However, if you are curions, you need to build onnx and execute the following command lines:
pip install onnx -e . -v
# python onnx/backend/test/cmd_tools.py generate-data --clean # needed if you add new backend test examples
# python onnx/backend/test/stat_coverage.py # needed if you add new backend test examples
python onnx/defs/gen_doc.py # generates the documentationThere was a problem hiding this comment.
Just to add to Xavier's comments: the CI has a mechanism for automatically generate the documentation (using the auto update doc label), but it seems to be not working right now due to some git-issue that needs to be fixed.
gramalingam
added
the
auto update doc
### Description release build breaks due to onnx#5806 filesystem not available on Mac 10.12. also need to skip 2 reference implement tests (test_qlinearmatmul_3D_int8_float16_cpu, test_qlinearmatmul_3D_int8_float32_cpu) which are failing on MacOS (onnx#5792) ### Motivation and Context fix mac release CI --------- Signed-off-by: Liqun Fu <liqfu@microsoft.com> Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com> Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com> Signed-off-by: wplf <975761915@qq.com>
Signed-off-by: wplf <975761915@qq.com>
justinchuby
removed
the
auto update doc
|
PR #5948 redoes this |
### Description Redo of PR #5826 (which has stalled), extended to address another issue in the documentation. Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>
### Description Redo of PR onnx#5826 (which has stalled), extended to address another issue in the documentation. Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> Signed-off-by: isdanni <leedanni@gmail.com>
Description
Delete the redundant dimension in the operators doc of Topk.
Motivation and Context