Fix typo in a variable name in example code. - Githubissues

ml-explore / mlx

MLX: An array framework for Apple silicon

https://ml-explore.github.io/mlx/

MIT License

15.01k stars 856 forks source link

Fix typo in a variable name in example code. #1104

Closed jaju closed 2 weeks ago

jaju commented 3 weeks ago

Rename df2dx2 to d2fdx2 - the appropriate naming for the second derivative
Update CONTRIBUTING.md - add needed python packages, and a virtual-env hint

Proposed changes

Renamed a variable to appropriately denote the second order derivative

Added an assert on the value, but I've been away from C++ for some time, so do suggest if a different approach for float equality assertion is needed

Also added a few instructions in CONTRIBUTING.md - which I hope is helpful.

Checklist

Put an x in the boxes that apply.

[x] I have read the CONTRIBUTING document
[x] I have run pre-commit run --all-files to format my code / installed pre-commit prior to committing changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have updated the necessary documentation (if needed)