Changes algo to function, removes potential future functions.

rapidsai · Feb 2, 2024 · f555f94 · f555f94
1 parent 6880088
commit f555f94
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 9 deletions.
diff --git a/python/nx-cugraph/README.md b/python/nx-cugraph/README.md
@@ -89,10 +89,9 @@ interface to its CUDA-based graph analytics library) and
 [CuPy](https://cupy.dev/) (a GPU-accelerated array library) to NetworkX's
 familiar and easy-to-use API.
 
-Below is the list of algorithms that are currently supported or planned to be
-supported in nx-cugraph.
+Below is the list of functions that are currently supported in nx-cugraph.
 
-| feature/algo                         | release/target version   |
+| function                             | release/target version   |
 |:-------------------------------------|:-------------------------|
 | ancestors                            | 24.02                    |
 | average_clustering                   | 24.02                    |
@@ -152,7 +151,6 @@ supported in nx-cugraph.
 | katz_centrality                      | 23.12                    |
 | krackhardt_kite_graph                | 23.12                    |
 | ladder_graph                         | 23.12                    |
-| leiden                               | ?                        |
 | les_miserables_graph                 | 23.12                    |
 | lollipop_graph                       | 23.12                    |
 | louvain_communities                  | 23.10                    |
@@ -186,7 +184,6 @@ supported in nx-cugraph.
 | truncated_tetrahedron_graph          | 23.12                    |
 | turan_graph                          | 23.12                    |
 | tutte_graph                          | 23.12                    |
-| uniform_neighbor_sample              | ?                        |
 | weakly_connected_components          | 24.02                    |
 | wheel_graph                          | 23.12                    |
 

diff --git a/python/nx-cugraph/update_readme.py b/python/nx-cugraph/update_readme.py
@@ -18,10 +18,12 @@
 
 from nx_cugraph.scripts.print_table import main as nxcg_print_table
 
-table_header_string = "| feature/algo | release/target version |"
-table_header_patt = re.compile(r"\| feature/algo[\s]+\| release/target version[\s]+\|")
+table_header_string = "| function | release/target version |"
+table_header_patt = re.compile(
+    r"\|[\s]+function[\s]+\|[\s]+release/target version[\s]+\|"
+)
 nxcg_algo_col_name = "dispatch_name"
-readme_algo_col_name = "feature/algo"
+readme_algo_col_name = "function"
 nxcg_version_col_name = "version_added"
 readme_version_col_name = "release/target version"
 
@@ -140,7 +142,7 @@ def main(readme_file_name="README.md"):
     # Rewrite the README with the updated table
     with open(readme_file_name, "w") as fd:
         print("\n".join(before_table_lines), file=fd)
-        print(merged.to_markdown(index=False), file=fd)
+        print(merged.to_markdown(index=False, disable_numparse=True), file=fd)
         print("\n".join(after_table_lines), file=fd)