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] Restore algorithms comparison table #248

Open
azriel1rf opened this issue Jan 8, 2025 · 1 comment
Open

[DOC] Restore algorithms comparison table #248

azriel1rf opened this issue Jan 8, 2025 · 1 comment

Comments

@azriel1rf
Copy link

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant