Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc]Add Apple Silicon installation instruction & fix typo #228

Merged
merged 1 commit into from
Mar 29, 2022
Merged

[Doc]Add Apple Silicon installation instruction & fix typo #228

merged 1 commit into from
Mar 29, 2022

Conversation

poinwater
Copy link
Contributor

Description

Added Apple Silicon Installation instruction in README.md
Fixed a few typos

Fixes # (issue)

Type of change

  • Bug fix
  • New Tutorial
  • Updated or additional documentation
  • Additional Testing
  • New Feature

Checklist:

  • I've properly formatted my code according to the guidelines
    • By running yapf
    • By running clang-format
  • This PR addresses an already submitted issue for TensorFlow Recommenders-Addons
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

How Has This Been Tested?

Run the commands in the terminal

README.md Outdated
**TFRA** Apple Silicon (M1) version requires:

- macOS 12.0.0+
- Python 3.9
Copy link
Member

@rhdong rhdong Mar 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should provide release for py3.8, because tensorflow-macos has py38 and py39 release: https://pypi.org/project/tensorflow-macos/2.5.0/#files

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added Python 3.8, but I need to test the TFRA build with Python 3.8 first. The testing may take 1-2 days.

README.md Outdated
@@ -169,8 +169,48 @@ bazel build --enable_runfiles build_pip_pkg
TF_NEED_CUDA=1 bazel-bin/build_pip_pkg artifacts
pip install artifacts/tensorflow_recommenders_addons_gpu-*.whl
```
##### Apple Silicon Support
**TFRA** Apple Silicon (M1) version requires:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just 'Requires:'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to "Requirements:".

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rhdong rhdong changed the title [Doc]Add Apple Silicon installation instruction && fix typo [Doc]Add Apple Silicon installation instruction & fix typo Mar 28, 2022
@rhdong
Copy link
Member

rhdong commented Mar 28, 2022

Adding a referring link at the near top would be better, such as: https://github.com/tensorflow/recommenders-addons/pull/228/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R79

for example;

For Apple silicon(M1), please refer to Apple Silicon Support.

---Please be noticed this link should be modified to the master branch.

@rhdong rhdong merged commit 00e2735 into tensorflow:master Mar 29, 2022
@poinwater poinwater deleted the poinwater-dev branch November 5, 2022 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants