Skip to content

Commit d4d4091

Browse files
committed
[DOC] adding "how to cite" info
1 parent a2d4644 commit d4d4091

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/md/welcome_bottom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If you are having issues, [please let me know](https://www.uib.no/en/persons/Nat
99

1010
## How to cite PyCVI
1111

12-
If you are using PyCVI in your work, please cite us using one of the following entries:
12+
If you are using PyCVI in your work, please cite us by using one of the following entries referring to the JOSS paper *PyCVI: A Python package for internal Cluster Validity Indices, compatible with time-series data* by N. Galmiche:
1313

1414
**BibTeX**:
1515

docs/md/welcome_top.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Welcome to PyCVI's documentation!
22

3+
[![Python package](https://github.com/nglm/pycvi/actions/workflows/python-package.yml/badge.svg)](https://github.com/nglm/pycvi/actions/workflows/python-package.yml)
4+
[![Documentation Status](https://readthedocs.org/projects/pycvi/badge/?version=latest)](https://pycvi.readthedocs.io/en/latest/?badge=latest)
5+
[![status](https://joss.theoj.org/papers/fb63888e0a78da2866b03247ce18909d/status.svg)](https://joss.theoj.org/papers/fb63888e0a78da2866b03247ce18909d)
6+
37
PyCVI is a Python package specialized in internal Clustering Validity Indices (CVI). Internal CVIs are used to select the best clustering among a set of pre-computed clusterings when no external information is available such as the labels of the datapoints.
48

59
Although being fundamental to clustering tasks and being an active research topic, very few internal CVIs are implemented in standard python libraries (only 3 in [scikit-learn](https://scikit-learn.org/stable/index.html), more were available in R but few were maintained and kept in CRAN). This is despite the well-known limitations of all existing CVIs and the need to use the right one(s) according to the specific dataset at hand.

0 commit comments

Comments
 (0)