rapidsai / raft

RAFT contains fundamental widely-used algorithms and primitives for machine learning and information retrieval. The algorithms are CUDA-accelerated and form building blocks for more easily writing high performance applications.

Home Page:https://docs.rapids.ai/api/raft/stable/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[DOC] Histogram binner incorrect documented number of arguments

rongcuid opened this issue · comments

Report incorrect documentation

Location of incorrect documentation
https://docs.rapids.ai/api/raft/stable/cpp_api/stats_summary/#_CPPv4I000E9histogramvRKN4raft9resourcesE8HistTypeN4raft18device_matrix_viewIK7value_t5idx_tN4raft9col_majorEEEN4raft18device_matrix_viewIi5idx_tN4raft9col_majorEEE9binner_op

Describe the problems or issues found in the documentation

The following line indicates the binner signature:

signature of binner_op is int func(value_t, IdxT);

This is incorrect. Real signature is int binner(value_t value, IdxT row, IdxT col)/

Steps taken to verify documentation is incorrect

  • Look at include/raft/stats/histogram.cuh:99

Suggested fix for documentation
Fix signature