Skip to content

Return algorithm diagrams to CUB docs #2319

@gevtushenko

Description

@gevtushenko

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docDocumentation-related items.

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions