[FIX]: fixed readme (added some tests for HC)

README.md

@@ -74,8 +74,8 @@ Graph состоит из следующих элементов:
 
 ## Краткий обзор для новых пользователей
 В первую очередь, необходимо сохранить данные в папку  
-```
-data_validation/dataset_name/raw
+```bash
+mkdir -p data_validation/dataset_name/raw
 ```
 Папка с данными должна содержать 2 или 3 файла, если решается задача классификации вершин и N*2 файла (где N -- размер датасета), если задача классификации графов:
 * **edges.txt** состоит из двух клонок, разделенных запятой; каждая строчка этого файла является парой вершин, между которыми есть ребро в графе.

README_ENG.md

@@ -76,8 +76,8 @@ Graph consists of
 
 ## Quick Tour for New Users
 First of all you need to save your raw data into folder 
-```
-data_validation/dataset_name/raw
+```bash
+mkdir -p data_validation/dataset_name/raw
 ```
 The data folder must contain two or three files if your task is Node Classification and N*2 files if your task is Graph Classification: 
 

hc/README.md

@@ -12,6 +12,7 @@
 Библиотека использует возможности `scikit-learn` и `scipy` для вычислений.
 
 ---
+Убедитесь, что вы находитесь в директории в `.../StableGNN/hc/`
 
 ## Установка
 1. Установите зависимости и проект:
@@ -45,8 +46,19 @@ print("Кластеры:", labels)
 ### Пример 2: Автоматический выбор количества кластеров
 ```python
 from hypergraph_clustering.clustering.auto_clustering import AutoClusterHypergraphClustering
+import numpy as np
 
-clustering = AutoClusterHypergraphClustering(linkage="average", max_clusters=5, scoring="silhouette")
+# Пример графа
+adjacency_matrix = np.array([
+    [0, 1, 1, 0],
+    [1, 0, 1, 0],
+    [1, 1, 0, 1],
+    [0, 0, 1, 0]
+])
+
+
+lm = len(adjacency_matrix) - 1
+clustering = AutoClusterHypergraphClustering(linkage="average", max_clusters=lm, scoring="silhouette")
 labels = clustering.fit(adjacency_matrix)
 
 print("Кластеры:", labels)

hc/requirements.txt

@@ -1,5 +1,6 @@
-numpy
-scikit-learn
-networkx
-pytest
-matplotlib
+numpy==1.26.4
+scikit-learn==1.6.0
+networkx==3.2.1
+pytest==8.3.4
+matplotlib==3.6.2
+lightgmb==4.5.0

hc/setup.py

@@ -1,15 +1,15 @@
 from setuptools import setup, find_packages
+from typing import Dict
+
+version: Dict[str, str] = {}
+with open("requirements.txt", "r") as f:
+    requirements = [x for x in f.read().splitlines() if "#" not in x]
 
 setup(
     name="hypergraph_clustering",
     version="0.1.0",
     description="Модуль для агломеративной кластеризации гиперграфов",
     author="nosignalx2k",
     packages=find_packages(),
-    install_requires=[
-        "numpy",
-        "scikit-learn",
-        "networkx",
-        "matplotlib"
-    ],
-)
+    install_requires=requirements,
+)

requirements.txt

@@ -1,4 +1,11 @@
-bamt==1.1.44
+bamt==1.1.47
 optuna==2.10.1
 pgmpy==0.1.20
-pandas==1.5.2
+pandas==1.5.2
+
+numpy==1.26.4
+scikit-learn==1.6.0
+networkx==3.2.1
+pytest==8.3.4
+matplotlib==3.6.2
+