From 60a052102190974b95b0c4ab0500c9d6d9dd306e Mon Sep 17 00:00:00 2001 From: Chenran Xu Date: Thu, 7 Mar 2024 17:05:14 +0900 Subject: [PATCH 1/2] Update README.md Add DOI and citation information --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34d32e3..89c1f7b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Tutorial on basic neural network concepts +[![DOI](https://zenodo.org/badge/759758400.svg)](https://zenodo.org/doi/10.5281/zenodo.10792272) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) - [Download the repository](#download-the-repository) @@ -133,9 +134,23 @@ The second part of the tutorial is in `2-mnist_training.ipynb` ## Citing the tutorial -This tutorial is registered [Zenodo](https://zenodo.org/), which means that there is a DOI for each code release. +This tutorial is registered [Zenodo](https://zenodo.org/). Please use this DOI when citing this code: +```bibtex +@software{andrea_santamaria_garcia_2024_10792273, + author = {Andrea Santamaria Garcia and + Chenran Xu}, + title = {{machine-learning-tutorial/neural-networks: v1.0.0}}, + month = 03, + year = 2024, + publisher = {Zenodo}, + version = {v1.0.0}, + doi = {10.5281/zenodo.10792273}, + url = {https://doi.org/10.5281/zenodo.10792273} +} +``` + ## Disclaimer The content of this repository was developed by the [AI4Accelerators team](https://www.ibpt.kit.edu/AI4Accelerators.php) at the [Institute of Beam Physics and Technology (IBPT)](https://www.ibpt.kit.edu/), [Karlsruhe Institute of Technology](https://www.kit.edu/english/). From a494186e7defe55cbcdf52d356fe9f4c79c8e1b8 Mon Sep 17 00:00:00 2001 From: Chenran Xu Date: Mon, 25 Mar 2024 14:04:48 +0100 Subject: [PATCH 2/2] Add CITATION.cff and Update README.md --- CITATION.cff | 18 ++++++++++++++++++ README.md | 10 +++++----- 2 files changed, 23 insertions(+), 5 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..f89d8e7 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,18 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: Santamaria Garcia + given-names: Andrea + affiliation: Karlsruhe Institute of Technology + orcid: "https://orcid.org/0000-0002-7498-7640" + - family-names: Xu + given-names: Chenran + affiliation: Karlsruhe Institute of Technology + orcid: "https://orcid.org/0000-0002-5034-2207" +title: "Tutorial on basic neural network concepts" +date-released: 2024-03-25 +type: software +version: 1.0.1 +doi: 10.5281/zenodo.10792273 +license: GPL-3.0 +url: "https://github.com/machine-learning-tutorial/neural-networks" diff --git a/README.md b/README.md index 89c1f7b..9c1ae18 100644 --- a/README.md +++ b/README.md @@ -138,14 +138,14 @@ This tutorial is registered [Zenodo](https://zenodo.org/). Please use this DOI when citing this code: ```bibtex -@software{andrea_santamaria_garcia_2024_10792273, - author = {Andrea Santamaria Garcia and - Chenran Xu}, - title = {{machine-learning-tutorial/neural-networks: v1.0.0}}, +@software{santamaria_garcia_2024_10792273, + author = {Santamaria Garcia, Andrea and + Xu, Chenran}, + title = {Tutorial on basic neural network concepts}, month = 03, year = 2024, publisher = {Zenodo}, - version = {v1.0.0}, + version = {v1.0.1}, doi = {10.5281/zenodo.10792273}, url = {https://doi.org/10.5281/zenodo.10792273} }