add CIKM publication for citation

collinleiber · Oct 23, 2023 · 477a1c8 · 477a1c8
1 parent 9695473
commit 477a1c8
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 0 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,35 @@
+cff-version: 1.2.0
+message: "If you use the ClustPy package in the context of a scientific publication, please cite it as follows"
+authors:
+- family-names: "Leiber"
+  given-names: "Collin"
+  orcid: https://orcid.org/0000-0001-5368-5697
+- family-names: "Miklautz"
+  given-names: "Lukas"
+  orcid: "https://orcid.org/0000-0002-2585-5895"
+title: "ClustPy"
+version: 0.0.2
+date-released: 2023-09-25
+url: "https://github.com/collinleiber/ClustPy"
+preferred-citation:
+  type: conference-paper
+  authors:
+    - family-names: "Leiber"
+      given-names: "Collin"
+      orcid: https://orcid.org/0000-0001-5368-5697
+    - family-names: "Miklautz"
+      given-names: "Lukas"
+      orcid: "https://orcid.org/0000-0002-2585-5895"
+    - family-names: "Plant"
+      given-names: "Claudia"
+      orcid: "https://orcid.org/0000-0001-5274-8123"
+    - family-names: "Böhm"
+      given-names: "Christian"
+      orcid: "https://orcid.org/0000-0002-2237-9969"
+  doi: "10.1145/3583780.3615290"
+  journal: "Proceedings of the 32nd ACM International Conference on Information and Knowledge Management"
+  month: 10
+  start: 5208 # First page number
+  end: 5211 # Last page number
+  title: "Application of Deep Clustering Algorithms"
+  year: 2023
diff --git a/README.md b/README.md
@@ -150,6 +150,27 @@ The following variable names are used:
 - 'CLUSTPY_DATA': Defines the path where downloaded datasets should be saved.
 - 'CLUSTPY_DEVICE': Define the device to be used for Pytorch applications. Example: `os.environ['CLUSTPY_DEVICE'] = 'cuda:1'`
 
+# Citation
+
+If you use the ClustPy package in the context of a scientific publication, please cite it as follows:
+
+*Leiber, C., Miklautz, L., Plant, C., Böhm, C. (2023, October).
+Application of Deep Clustering Algorithms.
+Proceedings of the 32nd ACM International Conference on Information and Knowledge Management.*
+
+**BibTeX:**
+```latex
+@inproceedings{leiber2023application,
+  title = {Application of Deep Clustering Algorithms},
+  author = {Leiber, Collin and Miklautz, Lukas and Plant, Claudia and Böhm, Christian},
+  booktitle = {Proceedings of the 32nd ACM International Conference on Information and Knowledge Management},
+  year = {2023},
+  pages = {5208–5211},
+  organization = {Association for Computing Machinery},
+  url = {https://doi.org/10.1145/3583780.3615290}
+}
+```
+
 # Compatible packages
 
 We stick as close as possible to the implementation details of sklean clustering. Therefore, our methods are compatible with many other packages. Examples are: