mlx icon indicating copy to clipboard operation
mlx copied to clipboard

[Feature] arctan2

Open yrahul3910 opened this issue 1 year ago • 2 comments

I want to eventually contribute to this Keras issue, and since this would be my first contribution, I want to start small and implement arctan2. If nobody is currently working on this, I would like to contribute this feature. Specifically, my implementation plan, based on looking at arctan, is as follows:

  • Add an ArcTan2 class to mlx/primitives.h, and its corresponding vjp, jvp, and vmap functions in mlx/primitives.cpp
  • Add an ArcTan2 struct to mlx/backend/common/ops.h, and overload the function call operator.
  • Add an ArcTan2 struct to mlx/backend/metal/unary.h, and add instantitate_unary_float calls in mlx/backend/metal/unary.metal. The necessary metal::precise::atan2 function seems to already be implemented.
  • Add tests, and update docs.

Please let me know if I can proceed.

yrahul3910 avatar May 02 '24 00:05 yrahul3910

Your description is right modulo the fact that it is a binary op not a unary op.

I would look at another binary op like Add as an example. Most of the implementation should be boiler plate copying of another binary primitive. The core change will be in the op struct which gets passed to the CPU / GPU binary op kernel.

awni avatar May 02 '24 01:05 awni

And yes please add this, that would be great!

awni avatar May 02 '24 01:05 awni

I think I did it :) When running make, I get warnings about the use of binary(...) (but it successfully builds and tests pass). This is because the binary function also tests bool, so std::atan2 warns about precision loss. I'm not entirely sure what to do there--maybe for future binary (but not bool) ops we have a different function called binary_fp, like we have for unary ops?

yrahul3910 avatar May 05 '24 03:05 yrahul3910