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

Return algorithm diagrams to CUB docs #2319

Open
21 tasks
gevtushenko opened this issue Aug 28, 2024 · 0 comments
Open
21 tasks

Return algorithm diagrams to CUB docs #2319

gevtushenko opened this issue Aug 28, 2024 · 0 comments
Assignees
Labels
doc Documentation-related items.

Comments

@gevtushenko
Copy link
Collaborator

gevtushenko commented Aug 28, 2024

We used to have algorithm diagrams in CUB docs. For instance, reduction used to have the following picture:

Image

We haven't carried these visualizations into the new sphinx-based docs but users found these very useful. There's an issue with adopting these images as is. First of all, they are at very low resolution. Apart from that, I'd like to avoid storing binary blobs in version control system. These concerns can be addressed if we change the approach to drawing these diagrams and use something like sphinxcontrib-tikz. That'd let us store images as text inline. This would further help when we adopt a different docs theme that had dark mode.

Tasks

  • Integrate sphinxcontrib-tikz into CCCL docs
  • Implement tikz version of block loading logo
  • Implement tikz version of block reduction logo
  • Implement tikz version of block scan raking logo
  • Implement tikz version of block scan warp scans logo
  • Implement tikz version of store logo
  • Implement tikz version of blocked arrangement diagram
  • Implement tikz version of CNP abstraction diagram
  • Implement tikz version of CUB overview diagram
  • Implement tikz version of generic abstraction diagram
  • Implement tikz version of histogram logo
  • Implement tikz version of partition logo
  • Implement tikz version of reduce logo
  • Implement tikz version of run length encode logo
  • Implement tikz version of scan logo
  • Implement tikz version of segmented sorting logo
  • Implement tikz version of select flags logo
  • Implement tikz version of select logo
  • Implement tikz version of striped arrangement diagram
  • Implement tikz version of unique logo
  • Implement tikz version of transpose logo

Legacy renders can be found here: https://github.com/NVlabs/cub/tree/gh-pages/docs/images.

@github-project-automation github-project-automation bot moved this to Todo in CCCL Aug 28, 2024
@gevtushenko gevtushenko mentioned this issue Aug 28, 2024
21 tasks
@gevtushenko gevtushenko added the doc Documentation-related items. label Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Status: Todo
Development

No branches or pull requests

2 participants