updated readme

matchms · Feb 11, 2025 · 0e01827 · 0e01827
1 parent a934c82
commit 0e01827
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -15,6 +15,6 @@ python -m pip install .
 
 ## Documentation
 
-This Python library allows the user to apply various modifications and community detection algorithms on a provided matrix of similarity measures and a graph created from the matrix. `main.py` shows the examplary use of the Python library. 
+This Python library allows the user to apply various modifications and community detection algorithms on a provided matrix of similarity measures and a graph created from the matrix. `main.ipynb` shows the examplary use of the Python library. 
 
 On the provided matrix a threshold and a normalization of the values can be applied. The values can be visualized as a histogram. After that a graph can be created. Different thresholds can also be applied on the graph and the edge weights can then be normalized. Different community detection algorithms can be applied to the graph and the results can be visualized in multiple ways. The images can then be exported or the graph and the recovered community partitions can be exportd as graphml files in order to visulize them with other tools.