cdlib icon indicating copy to clipboard operation
cdlib copied to clipboard

[DOC] Restore algorithms comparison table

Open azriel1rf opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe. It's currently difficult to quickly compare algorithm features when selecting appropriate methods. The algorithms' table from v0.3.0 was very helpful for this purpose, especially when looking for specific capabilities like overlapping community detection in weighted graphs.

Reference https://cdlib.readthedocs.io/en/v0.3.0/reference/cd_algorithms/algorithms.html

Describe the solution you'd like Restore the algorithms' comparison table to the documentation, updated with any new algorithms added since v0.3.0.

Describe alternatives you've considered While feature tags exist in individual algorithm documentation pages, having a comprehensive table would make it much easier to compare multiple algorithms at once.

azriel1rf avatar Jan 08 '25 12:01 azriel1rf

I can help create a GitHub Action workflow that automatically updates the comparison table by parsing algorithm docstrings and generating the table when implementations change. This would keep the documentation always in sync with the codebase.

azriel1rf avatar Jan 08 '25 12:01 azriel1rf

@azriel1rf that's would be a particularly welcomed contribution!

GiulioRossetti avatar Jan 09 '25 09:01 GiulioRossetti