Citation + Contributor acknowledgment section (#207)

* cite

* nits

* nits

* comment
This commit is contained in:
Awni Hannun 2023-12-18 10:07:00 -08:00 committed by GitHub
parent 18cca64c81
commit 477397bc98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 6 deletions

View File

@ -1,3 +1,15 @@
# 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` and `bar` ops.
MLX was developed with contributions from the following individuals:
# Third-Party Software
MLX leverages several third-party software, listed here together with MLX leverages several third-party software, listed here together with
their license copied verbatim. their license copied verbatim.

View File

@ -79,11 +79,28 @@ for more information on building the C++ and Python APIs from source.
## Contributing ## Contributing
Check out the [contribution guidelines](CONTRIBUTING.md) for more information Check out the [contribution guidelines](CONTRIBUTING.md) for more information
on contributing to MLX. on contributing to MLX. See the
[docs](https://ml-explore.github.io/mlx/build/html/install.html) for more
information on building from source, and running tests.
Optional: Generate stubs for C++ python objects to enable IDE auto-completion 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.
```shell ## Citing MLX
pip install ".[dev]"
python setup.py generate_stubs 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},
}
```