From dbea72c3eb7b051c75b01638a7fa8d56a9a495ac Mon Sep 17 00:00:00 2001 From: Marina Zhang Date: Wed, 29 Nov 2023 22:46:38 -0800 Subject: [PATCH 1/3] add CITATION.cff --- CITATION.cff | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..d4e130ae --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,21 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - given-names: "Elie" + family-names: "Bursztein" + - given-names: "James" + family-names: "Long" + - given-names: "Shun" + family-names: "Lin" + - given-names: "Owen" + family-names: "Vallis" + - given-names: "Ali" + family-names: "Zand" + - given-names: "Luke" + family-names: "Wood" + - given-names: "François" + family-names: "Chollet" +title: "TensorFlow Similarity: Metric Learning for Humans" +version: 0.18 +date-released: 2023-09-11 +url: "https://github.com/tensorflow/similarity" \ No newline at end of file From 06035f22c3945aaf4224eb55f7095b377306a248 Mon Sep 17 00:00:00 2001 From: Marina Zhang Date: Wed, 29 Nov 2023 22:47:52 -0800 Subject: [PATCH 2/3] fix citaiton in readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f34de69..b5bba156 100644 --- a/README.md +++ b/README.md @@ -148,11 +148,12 @@ Tensorflow Similarity offers many of the most common metrics used for [classific Please cite this reference if you use any part of TensorFlow similarity in your research: ```bibtex -@article{EBSIM21, - title={TensorFlow Similarity: A Usable, High-Performance Metric Learning Library}, - author={Elie Bursztein, James Long, Shun Lin, Owen Vallis, Francois Chollet}, - journal={Fixme}, - year={2021} +@software{TensorFlow_Similarity_2023, +author = {Bursztein, Elie and Long, James and Lin, Shun and Vallis, Owen and Zand, Ali and Wood, Luke and Chollet, François}, +title = {{TensorFlow Similarity: Metric Learning for Humans}}, +url = {https://github.com/tensorflow/similarity}, +version = {0.18}, +year = {2023} } ``` From 89f9f43c7e449496e4ed7f8d381bc7cd57de42ff Mon Sep 17 00:00:00 2001 From: Marina Zhang Date: Wed, 29 Nov 2023 23:05:26 -0800 Subject: [PATCH 3/3] reorder by first name last name for README citation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5bba156..ad51ebb2 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ Please cite this reference if you use any part of TensorFlow similarity in your ```bibtex @software{TensorFlow_Similarity_2023, -author = {Bursztein, Elie and Long, James and Lin, Shun and Vallis, Owen and Zand, Ali and Wood, Luke and Chollet, François}, +author = {Elie Bursztein, James Long, Shun Lin, Owen Vallis, Ali Zand, Luke Wood and François Chollet}, title = {{TensorFlow Similarity: Metric Learning for Humans}}, url = {https://github.com/tensorflow/similarity}, version = {0.18},