Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Histogram binner incorrect documented number of arguments #2160

Open
rongcuid opened this issue Feb 6, 2024 · 0 comments
Open

[DOC] Histogram binner incorrect documented number of arguments #2160

rongcuid opened this issue Feb 6, 2024 · 0 comments
Labels
doc Documentation

Comments

@rongcuid
Copy link

rongcuid commented Feb 6, 2024

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


@rongcuid rongcuid added the doc Documentation label Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

1 participant