From 109a017b6e76f14f641af59d986672af36df9568 Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Mon, 18 Dec 2023 07:55:25 -0800 Subject: [PATCH] citation + acks section --- ACKNOWLEDGMENTS.md | 8 ++++++++ README.md | 23 +++++++++++++++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 ACKNOWLEDGMENTS.md diff --git a/ACKNOWLEDGMENTS.md b/ACKNOWLEDGMENTS.md new file mode 100644 index 00000000..7b7b030d --- /dev/null +++ b/ACKNOWLEDGMENTS.md @@ -0,0 +1,8 @@ +# Individual Contributors + +If you wish to be acknowledged for your contributions, please list your name +with a short description of your contribution(s) below. For example: + +- Jane Smith: Added the `foo` example. + +MLX Examples was developed with contributions from the following individuals: diff --git a/README.md b/README.md index 7988e37a..f739a538 100644 --- a/README.md +++ b/README.md @@ -18,5 +18,24 @@ Some more useful examples include: ## Contributing -Check out the [contribution guidelines](CONTRIBUTING.md) for more information -on contributing to this repo. +We are grateful for all of [our +contributors](ACKNOWLEDGMENTS.md#Individual-Contributors). If you contribute +to MLX and wish to be acknowledged, please add your name to to the list in your +pull request. + +## Citing MLX Examples + +The MLX software suite was initially developed with equal contribution by Awni +Hannun, Jagrit Digani, Angelos Katharopoulos, and Ronan Collobert. If you find +MLX useful in your research and wish to cite it, please use the following +BibTex entry: + +``` +@software{mlx2023, + author = {Awni Hannun and Jagrit Digani and Angelos Katharopoulos and Ronan Collobert}, + title = {{MLX}: Efficient and flexible machine learning on Apple silicon}, + url = {https://github.com/ml-explore}, + version = {0.0}, + year = {2023}, +} +```