Skip to content

Commit c157d64

Browse files
authored
Update README.md
1 parent f628f8b commit c157d64

File tree

1 file changed

+40
-12
lines changed

1 file changed

+40
-12
lines changed

README.md

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84,21 +84,21 @@ Simply install DenMune clustering algorithm using pip command from the official
8484
From the shell run the command
8585

8686
```shell
87-
pip install denmune
87+
pip install denmune
8888
```
8989

9090
From Jupyter notebook cell run the command
9191

9292
```ipython3
93-
!pip install denmune
93+
!pip install denmune
9494
```
9595

9696
## How to use DenMune
9797

9898
Once DenMune is installed, you just need to import it
9999

100100
```python
101-
from denmune import DenMune
101+
from denmune import DenMune
102102
```
103103

104104
*<u>Please note that first denmune (the package) in small letters, while the other one(the class itself) has D and M in capital case</u>.*
@@ -229,23 +229,23 @@ def __init__ (self,
229229
- test_data:
230230

231231
- data used for testing the algorithm
232-
232+
233233
- test_truth:
234234

235235
- labels of testing data
236236
- default: None
237-
237+
238238
- k_nearest:
239239

240240
- number of nearest neighbor
241241
- default: 1. k-nearest neighbor should be at least 1.
242-
242+
243243
- rgn_tsn:
244244

245245
- when set to True: It will regenerate the reduced 2-D version of the N-D dataset each time the algorithm run.
246246
- when set to False: It will generate the reduced 2-D version of the N-D dataset first time only, then will reuse the saved exist file
247247
- default: True
248-
248+
249249
- file_2d: name (include location) of file used save/load the reduced 2-d version
250250

251251
- if empty: the algorithm will create temporary file named '_temp_2d'
@@ -272,19 +272,18 @@ def fit_predict(self,
272272
- validate:
273273
- validate data on/off according to five measures integrated with DenMune (Accuracy. F1-score, NMI index, AMI index, ARI index)
274274
- default: True
275-
275+
276276
- show_plots:
277277
- show/hide plotting of data
278278
- default: True
279-
279+
280280
- show_noise:
281281
- show/hide noise and outlier
282282
- default: True
283-
283+
284284
- show_analyzer:
285285
- show/hide the analyzer
286286
- default: True
287-
288287

289288
## The Analyzer
290289

@@ -371,6 +370,7 @@ The following chart shows the evolution of pre and post identified noise in corr
371370

372371

373372
## The Stability
373+
374374
The algorithm is only single-parameter, even more it not sensitive to changes in that parameter, k. You may guess that from the following chart yourself. This is of great benefit for you as a data exploration analyst. You can simply explore the dataset using an arbitrary k. Being Non-sensitive to changes in k, make it robust and stable.
375375

376376
![DenMune Stability chart](https://raw.githubusercontent.com/egy1st/images/main/clustering/stability.png)
@@ -450,6 +450,7 @@ Here is a list of Google CoLab & Kaggle notebooks to practice the use of the alg
450450

451451

452452
## Software Impact
453+
453454
Discover robust clustering without density cutoffs using this open-source Python library pyMune, implementing the parameter-free DenMune algorithm. PyMune identifies and expands cluster cores while removing noise. Fully scikit-learn compatible. pyMune (DenMune implementation) is a cutting-edge tool incorporating advanced techniques, robust performance, and effective propagation strategies. This positions it as the current state-of-the-art in its field, contributing to its high adoption and impact.
454455

455456
- After extensive research and rigorous validation, we are proud to release pyMune as an open-source tool on GitHub and PyPi for the benefit of the scientific community.
@@ -459,6 +460,31 @@ Discover robust clustering without density cutoffs using this open-source Python
459460

460461
![Software Impact](https://github.com/egy1st/images/blob/main/clustering/software-impacts.png?raw=true)
461462

463+
### Warning: Plagiarized Works
464+
465+
It has come to our attention that the following papers have plagiarized significant portions of the DenMune algorithm and research work:
466+
467+
1. **Paper 1:** "DEDIC: Density Estimation Clustering Method Using Directly Interconnected Cores" published in IEEE Access, doi: 10.1109/ACCESS.2022.3229582 Authors: Yisen Lin, Xinlun Zhang, Lei Liu, and Huichen Qu, reported at https://pubpeer.com/publications/AFC4E173A4FC0A2AD7E70DE688DDA5
468+
2. **Paper 2:** "Research on stress curve clustering algorithm of Fiber Bragg grating sensor" published in Nature Scientific Reports, doi: 10.1038/s41598-023-39058-w Authors: Yisen Lin, Ye Wang, Huichen Qu  & Yiwen Xiong, reported at https://pubpeer.com/publications/7AEF7D0F7505A8B8C130D142522741
469+
470+
We have conducted a thorough analysis and found extensive evidence of plagiarism in these papers, including:
471+
472+
- Verbatim copying of the core algorithm logic and steps from DenMune, with only superficial naming and implementation differences intended to obfuscate the similarity.
473+
- Plagiarized background, related work, and technical details from the original DenMune paper, with minor paraphrasing and without proper attribution.
474+
- Copying of mathematical formulations, concepts, and point classifications from DenMune.
475+
- Reuse of experimental setup, datasets, and compared algorithms from DenMune without justification or acknowledgment.
476+
- Fabricated experimental results, with values directly copied from DenMune's results and falsely claimed as their own.
477+
- Lack of substantive analysis or discussion, further indicating that the experiments were likely not conducted.
478+
479+
Despite our efforts to address these concerns through proper channels, the publishers have decided to allow these plagiarized papers to remain published with only a correction acknowledging the issues, rather than retracting them or mandating a comprehensive correction.
480+
481+
We strongly condemn such academic misconduct and the potential enabling of plagiarism by reputable publishers. Researchers and practitioners should exercise caution when referring to or using the methods described in these plagiarized works.
482+
483+
For the original, properly cited implementation of the DenMune clustering algorithm, please refer to the official repository and resources provided here.
484+
485+
We remain committed to upholding academic integrity and ethical research practices, and we urge the scientific community to take a firm stance against plagiarism and misconduct in scholarly publications.
486+
487+
462488

463489
## How to cite
464490

@@ -493,7 +519,7 @@ abstract = {Many clustering algorithms fail when clusters are of arbitrary shape
493519

494520

495521
- How to cite ***The Software***
496-
If you have used this codebase in a scientific publication and wish to cite it, please use the [Journal of Software Impacts article](https://www.sciencedirect.com/science/article/pii/S266596382300101X):
522+
If you have used this codebase in a scientific publication and wish to cite it, please use the [Journal of Software Impacts article](https://www.sciencedirect.com/science/article/pii/S266596382300101X):
497523

498524
```
499525
Abbas, M. A., El-Zoghabi, A., & Shoukry, A. (2023). PyMune: A Python package for complex clusters detection. Software Impacts, 17, 100564. https://doi.org/10.1016/j.simpa.2023.100564
@@ -514,13 +540,15 @@ keywords = {Machine learning, Pattern recognition, Dimensionality reduction, Mut
514540
abstract = {We introduce pyMune, an open-source Python library for robust clustering of complex real-world datasets without density cutoff parameters. It implements DenMune (Abbas et al., 2021), a mutual nearest neighbor algorithm that uses dimensionality reduction and approximate nearest neighbor search to identify and expand cluster cores. Noise is removed with a mutual nearest-neighbor voting system. In addition to clustering, pyMune provides classification, visualization, and validation functionalities. It is fully compatible with scikit-learn and has been accepted into the scikit-learn-contrib repository. The code, documentation, and demos are available on GitHub, PyPi, and CodeOcean for easy use and reproducibility.}
515541
}
516542
```
543+
517544
## Licensing
518545

519546
The DenMune algorithm is 3-clause BSD licensed. Enjoy.
520547

521548
[![BSD 3-Clause “New” or “Revised” License](https://img.shields.io/badge/license-BSD-green)](https://choosealicense.com/licenses/bsd-3-clause/)
522549

523550
## Task List
551+
524552
- [x] Update Github with the DenMune source code
525553
- [x] create repo2docker repository
526554
- [x] Create pip Package

0 commit comments

Comments
 (0)