Add support for publishing macOS M1 ARM64 wheels #2559

lgeiger · 2021-09-07T23:13:10Z

Description

This PR adds a release script and updated the GitHub actions workflow to publish cross compiled ARM64 macOS wheels. Recent XCode version support cross compilation, so we can generate ARM64 wheels on the x86 GitHub actions VMs.

Fixes #2503

Checklist:

I've properly formatted my code according to the guidelines
- By running Black + Flake8
- By running pre-commit hooks
This PR addresses an already submitted issue for TensorFlow Addons
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
This PR contains modifications to C++ custom-ops

How Has This Been Tested?

I manually verified the generated wheel on a ARM64 M1 Mac.

~~I am not sure what to do about the Run the cpu tests in a small python docker image CI failure. It seems unrelated to this PR. @seanpmorgan What do you think?~~

lgeiger · 2021-09-07T23:13:38Z

.github/workflows/make_wheel_macOS_arm64.sh

+python configure.py
+
+bazel build \
+  --cpu=darwin_arm64 \


This CPU setting makes sure that we cross compile for ARM64.

lgeiger · 2021-09-07T23:16:11Z

.github/workflows/make_wheel_macOS_arm64.sh

+  --copt -mmacosx-version-min=11.0 \
+  --linkopt -mmacosx-version-min=11.0 \


We don't need to support 10.13 since the only the latest version macOS version currently supports ARM64. But setting a minimum version here makes sure that the script will keep working even if the GitHub actions VM are updated to 11.1 at some point in the future.

lgeiger · 2021-09-07T23:16:36Z

.github/workflows/make_wheel_macOS_arm64.sh

+  --test_output=errors \
+  build_pip_pkg
+
+bazel-bin/build_pip_pkg artifacts "--plat-name macosx_11_0_arm64 $NIGHTLY_FLAG"


We need to manually set the correct wheel name, since we are cross compiling on an x86 machine.

lgeiger · 2021-09-08T14:02:01Z

.github/workflows/release.yml

+          - os: 'macos-11'
+            cpu: 'arm64'
+            tf-version: '2.5.0'
+            py-version: '3.8'
+          - os: 'macos-11'
+            cpu: 'arm64'
+            tf-version: '2.5.0'
+            py-version: '3.9'


tensorflow-macos currently only supports TF 2.5.0 and Python 3.8 and 3.9.

And tensorflow-metal?

As far as I can tell tensorflow-metal is an optional dependency to enable metal support via the new pluggable device mechanism so it is not really necessary here since as far as I know TFA doesn't directly link against the metal plugin.

Yes I meant if It Is constrained to 2.5.0 now I suppose that all the macos stuffs are aligned on 2.5.0 including GPU acell

Yes, tensorflow-metal is also only built against 2.5.0 currently.

Yes, as I told you it is not about conflicts, It is about that if tensorflow-macos is imminent to land on 2.6.0 as tensorflow-deps is ready for TF 2.6.0 I will just wait to edit this PR directly to have a 2.6.0 wheel published for TF addons.
If not probably we will merge as is.

Yes, as I told you it is not about conflicts, It is about that if tensorflow-macos is imminent to land on 2.6.0 as tensorflow-deps is ready for TF 2.6.0 I will just wait to edit this PR directly to have a 2.6.0 wheel published for TF addons.
If not probably we will merge as is.

@mihaimaruseac and @penpornk

Thanks @bhack for the heads-up. Is this PR for enabling ARM64 builds for TF through official build channels which will be hosted on pypi ?

Is this PR for enabling ARM64 builds for TF through official build channels which will be hosted on pypi ?

No this is limited for Tensorflow Addons ARM64 builds in the official Tesnroflow Addons pypi so we need to know if we could enable 2.6.0 for tensorflow-macos 2.6.0.

ARM64 builds for TF through official build channels which will be hosted on pypi

For this you really need a brand new PR in the TF own repository over:
(Stable)
https://github.com/tensorflow/tensorflow/tree/master/tensorflow/tools/ci_build/rel/macos
(Eventually nightly)
https://github.com/tensorflow/tensorflow/tree/master/tensorflow/tools/ci_build/nightly_release/macos

But it is another topic.

@bhack , thanks for the update. We are working on the v2.6 release, I will update here regarding that. I see this PR has merged we can adopt to tensorflow-macos after we make the release in a separate PR.

@kulinseth Are you interested to manage the TF addons wheels release on your pypi on a new tensorflow-macos/metal release?

lgeiger · 2021-09-08T14:45:26Z

We briefly tested the generated Python 3.9 wheel and it seems to work fine on a M1 ARM Mac with tensorflow-macos installed.

bhack · 2021-09-08T14:54:01Z

/cc @tetsuyasu can you check this on your system?

bhack · 2021-09-08T20:18:12Z

/cc @mbui0327

tetsuyasu · 2021-09-08T23:53:18Z

/cc @tetsuyasu can you check this on your system?

It works fine.

seanpmorgan

LGTM from a build standpoint. Thanks @lgeiger we've had a number of requests for this.

lgeiger · 2021-09-10T10:43:30Z

Great! Thanks for the fast review and merge 🚀

How do you feel about backporting this to 0.13 and 0.14?

bhack · 2021-09-10T11:19:09Z

How do you feel about backporting this to 0.13 and 0.14?

I think it is ok.

* Add support for publishing macOS M1 ARM64 wheels * Link against the tensorflow-macos when building for ARM Macs

bhack · 2021-09-10T14:05:20Z

@lgeiger We had some problem in https://github.com/tensorflow/addons/actions/runs/1220898795

macos-11-3.9-tf2.5.0-arm64-wheel" was not found.

lgeiger · 2021-09-10T14:31:37Z

@lgeiger We had some problem in https://github.com/tensorflow/addons/actions/runs/1220898795

Very sorry about that, #2565 should fix this typo.

bhack · 2021-09-10T14:54:33Z

Thanks, when it is merged can you post an announce in the forum?

seanpmorgan · 2021-09-14T02:17:24Z

@bhack @lgeiger Any thoughts on how we should handle the lagging tensorflow-macos releases? If it's going to lag by ~month I won't be in favor of waiting for it. IMO the obvious answer is for tensorflow core to publish an arm64 macos whl... @kulinseth are there any plans to submit that PR or is a separate whl the path forward?

Other options I see:

We could release a patch once tensorflow-macos catches up, but not really thrilled to absorb that burden and x.0 releases would be exempt from arm64 macos
We could only build macos arm for tfa-nightly. And then it's just a best effort thing

...open to other ideas but would like a good reason why tf core can't publish the build along with all the others.

lgeiger · 2021-09-14T09:51:17Z

IMO the obvious answer is for tensorflow core to publish an arm64 macos whl

I fully agree. To me, it seems like there shouldn't be any technical blockers for a proper arm64 macos wheel as it can be cross compiled on the existing macos CI infra. It is probably just a matter of priorities for the TF/Apple teams.

bhack · 2021-09-14T10:48:33Z

I think It is relatively easy to make a PR
in the MacOS directory I've mentioned.
But the problem is more related to the current CI script orchestration (Kokoro/Jenkins) that It isn't so clear for a contributor as Github actions cause it is not hosted in the repository so we don't have exactly the full overview of the CI.

The second point is:
Do we really need to wait for the tensorflow-metal release also on M1?
Can tensorflow-metal depend on the official TF wheel instead of tensorflow-macos or is there something different in this build other then the arm64 support?

bhack · 2021-09-27T22:44:15Z

@lgeiger Can you check the CI in the latest PRs?

lgeiger · 2021-10-05T15:01:48Z

Sorry for the late reply, I was away the last weeks.

Do we really need to wait for the tensorflow-metal release also on M1?

tensorflow-metal is just the device plugin for metal support for M1 Macs, so as far as I can tell tensorflow-macos can be used without tensorflow-metal just fine.

@lgeiger Can you check the CI in the latest PRs?

@bhack Could you clarify what you mean by that?

bhack · 2021-10-05T15:20:45Z

Could you clarify what you mean by that?

Nevermind, MacOS builds were failing but it is solved.

bhack · 2021-11-06T14:42:12Z

@seanpmorgan We could have some effect on the chain if we don't (or with @kulinseth) handle the M1 release.
See what happens in TF federated:
https://github.com/tensorflow/federated/issues/1254#issuecomment-803938932

seanpmorgan · 2021-11-09T04:10:25Z

@seanpmorgan We could have some effect on the chain if we don't (or with @kulinseth) handle the M1 release. See what happens in TF federated: tensorflow/federated#1254 (comment)

Given discussion at the last SIG meeting, we won't support TFA releases on M1 ARM until an acceptable SLA can be given from Apple on their release of tensorflow-macos. I'm okay with continuing the TFA-Nightly support though while we wait to see what happens. Only issue there is tfa-nightly arm may be compiled against an older TF version (would only affect custom ops)

Add support for publishing macOS M1 ARM64 wheels

9634f7f

boring-cyborg bot added the github label Sep 7, 2021

google-cla bot added the cla: yes label Sep 7, 2021

lgeiger commented Sep 7, 2021

View reviewed changes

bhack marked this pull request as ready for review September 7, 2021 23:34

lgeiger force-pushed the macos-arm64 branch from 99379c2 to 2fd175e Compare September 8, 2021 13:54

Link against the tensorflow-macos when building for ARM Macs

a8e1695

lgeiger force-pushed the macos-arm64 branch from 2fd175e to a8e1695 Compare September 8, 2021 13:56

lgeiger commented Sep 8, 2021

View reviewed changes

lgeiger requested a review from bhack September 8, 2021 14:45

bhack approved these changes Sep 8, 2021

View reviewed changes

bhack added the kokoro:force-run label Sep 8, 2021

bhack requested a review from seanpmorgan September 8, 2021 20:17

kokoro-team removed the kokoro:force-run label Sep 8, 2021

seanpmorgan approved these changes Sep 9, 2021

View reviewed changes

bhack merged commit 2bb46df into tensorflow:master Sep 10, 2021

lgeiger deleted the macos-arm64 branch September 10, 2021 10:42

lgeiger added a commit to lgeiger/addons that referenced this pull request Sep 10, 2021

Add support for publishing macOS M1 ARM64 wheels (tensorflow#2559)

153aad9

lgeiger added a commit to lgeiger/addons that referenced this pull request Sep 10, 2021

Add support for publishing macOS M1 ARM64 wheels (tensorflow#2559)

bebaf1d

* Add support for publishing macOS M1 ARM64 wheels * Link against the tensorflow-macos when building for ARM Macs

This was referenced Sep 10, 2021

[r0.14-cherry-pick] Add support for publishing macOS M1 ARM64 wheels #2562

Merged

[r0.13-cherry-pick] Add support for publishing macOS M1 ARM64 wheels #2563

Merged

bhack pushed a commit that referenced this pull request Sep 10, 2021

Add support for publishing macOS M1 ARM64 wheels (#2559) (#2562)

4d86626

* Add support for publishing macOS M1 ARM64 wheels * Link against the tensorflow-macos when building for ARM Macs

bhack pushed a commit that referenced this pull request Sep 10, 2021

Add support for publishing macOS M1 ARM64 wheels (#2559) (#2563)

7a5d91b

lgeiger mentioned this pull request Sep 10, 2021

Fix ARM wheel uploading in release script #2565

Merged

seanpmorgan mentioned this pull request Sep 14, 2021

tensorflow_addons tutorial #2537

Closed

lgeiger mentioned this pull request Oct 8, 2021

⬆️ tensorflow-macos==2.6.0 #2582

Merged

seanpmorgan mentioned this pull request Dec 22, 2021

MacOS Arm64 support for stable TF-Addons Releases #2631

Closed

gcroci2 mentioned this pull request Feb 7, 2022

Fix for installation on macbooks with M1 chips dianna-ai/dianna#200

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for publishing macOS M1 ARM64 wheels #2559

Add support for publishing macOS M1 ARM64 wheels #2559

lgeiger commented Sep 7, 2021 •

edited

Loading

lgeiger Sep 7, 2021

lgeiger Sep 7, 2021

lgeiger Sep 7, 2021

lgeiger Sep 8, 2021

bhack Sep 8, 2021 •

edited

Loading

lgeiger Sep 8, 2021

bhack Sep 8, 2021 •

edited

Loading

lgeiger Sep 8, 2021 •

edited

Loading

bhack Sep 9, 2021

kulinseth Sep 9, 2021

bhack Sep 9, 2021 •

edited

Loading

kulinseth Sep 10, 2021

bhack Nov 6, 2021

lgeiger commented Sep 8, 2021

bhack commented Sep 8, 2021

bhack commented Sep 8, 2021

tetsuyasu commented Sep 8, 2021

seanpmorgan left a comment

lgeiger commented Sep 10, 2021

bhack commented Sep 10, 2021

bhack commented Sep 10, 2021

lgeiger commented Sep 10, 2021 •

edited

Loading

bhack commented Sep 10, 2021

seanpmorgan commented Sep 14, 2021

lgeiger commented Sep 14, 2021

bhack commented Sep 14, 2021

bhack commented Sep 27, 2021

lgeiger commented Oct 5, 2021

bhack commented Oct 5, 2021

bhack commented Nov 6, 2021

seanpmorgan commented Nov 9, 2021

		--copt -mmacosx-version-min=11.0 \
		--linkopt -mmacosx-version-min=11.0 \

Add support for publishing macOS M1 ARM64 wheels #2559

Add support for publishing macOS M1 ARM64 wheels #2559

Conversation

lgeiger commented Sep 7, 2021 • edited Loading

Description

Checklist:

How Has This Been Tested?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhack Sep 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhack Sep 8, 2021 • edited Loading

Choose a reason for hiding this comment

lgeiger Sep 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhack Sep 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgeiger commented Sep 8, 2021

bhack commented Sep 8, 2021

bhack commented Sep 8, 2021

tetsuyasu commented Sep 8, 2021

seanpmorgan left a comment

Choose a reason for hiding this comment

lgeiger commented Sep 10, 2021

bhack commented Sep 10, 2021

bhack commented Sep 10, 2021

lgeiger commented Sep 10, 2021 • edited Loading

bhack commented Sep 10, 2021

seanpmorgan commented Sep 14, 2021

lgeiger commented Sep 14, 2021

bhack commented Sep 14, 2021

bhack commented Sep 27, 2021

lgeiger commented Oct 5, 2021

bhack commented Oct 5, 2021

bhack commented Nov 6, 2021

seanpmorgan commented Nov 9, 2021

lgeiger commented Sep 7, 2021 •

edited

Loading

bhack Sep 8, 2021 •

edited

Loading

bhack Sep 8, 2021 •

edited

Loading

lgeiger Sep 8, 2021 •

edited

Loading

bhack Sep 9, 2021 •

edited

Loading

lgeiger commented Sep 10, 2021 •

edited

Loading