Add tf-text tutorials.

Author: sun1638650145

.gitignore

@@ -0,0 +1,2 @@
+.DS_store
+.idea/

README-zh.md

@@ -0,0 +1,10 @@
+# 用于 Apple Silicon 的 TensorFlow 库和扩展
+
+这个仓库将提供需要编译才能构建的 TensorFlow 库和拓展的构建教程, 同时也提供预编译的`wheel`文件. 本教程提供[简体中文]()和[English]()支持.
+
+## 目前提供的教程👉
+
+* [addons](https://github.com/tensorflow/addons)
+* [text](https://github.com/tensorflow/text)
+* 未完待续
+

README.md

@@ -1 +1,10 @@
-# Libraries-and-Extensions-for-TensorFlow-for-Apple-Silicon
+# Libraries and Extensions for TensorFlow for Apple Silicon
+
+This Repo will provide TensorFlow libraries and extended build tutorials that require compilation to build, as well as pre-compiled `wheel` files. This tutorial provides [English]() and [简体中文]() support.
+
+## Currently available tutorials 👉🏻
+
+* [addons](https://github.com/tensorflow/addons)
+* [text](https://github.com/tensorflow/text)
+* To be continued...
+

tutorials/text/text-zh.md

@@ -0,0 +1,74 @@
+# 从源码构建TensorFlow Text
+
+## 必要条件
+
+这里假设了您有必要的类Unix知识, 已经在您的终端内安装好了[`brew`](https://brew.sh)和[`conda`](https://github.com/conda-forge/miniforge), 这里不再赘述`brew`和`conda`安装和使用方法; 最重要的是, 这个教程完全基于Apple Silicon(比如M1, M1 Pro 或者 M1 Max)构建, 所以确保您手中的Mac是Apple Silicon.
+
+## Step by Step
+
+1. 创建新的环境并安装Apple提供的依赖项.
+
+   ```shell
+   conda create -n tensorflow-macos python=3.9 # 这里Python版本也可以使用Python 3.8
+   conda activate tensorflow-macos
+   conda install -c apple tensorflow-deps==2.8.0
+   ```
+
+2. 安装`tensorFlow-macos`和`tensorflow-metal`插件.
+
+   ```shell
+   pip install tensorflow-macos
+   pip install tensorflow-metal
+   ```
+
+3. 安装`bazel 4.2.2`.
+
+   ```shell
+   wget https://raw.githubusercontent.com/Homebrew/homebrew-core/210bef2d570f0635e07009f4c5242b5e6645ae31/Formula/bazel.rb
+   brew install ./bazel.rb
+   bazel --version # 确保版本是4.2.2
+   ```
+
+   * 通常情况下`brew`安装的`bazel`会是最新版的, 最新版往往和`text`要求的版本不匹配, 这可能会出现很多意想不到的问题, 所以我们通过手动指定版本安装.
+
+4. 下载并解压`text 2.8.1 `.
+
+   ```shell
+   wget https://github.com/tensorflow/text/archive/refs/tags/v2.8.1.zip
+   unzip ./v2.8.1.zip
+   cd text-2.8.1
+   ```
+
+5. 修改源码的一些参数以此确保能正确构建.
+
+   * `oss_scripts/configure.sh `修改第49行为
+
+     ```shell
+     pip install tensorflow-macos==2.8.0
+     ```
+
+   * `oss_scripts/run_build.sh `注释掉第17行
+
+     ```shell
+     # source oss_scripts/prepare_tf_dep.sh
+     ```
+
+   * `oss_scripts/pip_package/setup.py` 修改第76, 77行为 
+
+     ```python
+     'tensorflow>=2.8.0, <2.9.0; platform_machine != "arm64" or platform_system != "Darwin"',
+     'tensorflow-macos>=2.8.0, <2.9.0; platform_machine == "arm64" and platform_system == "Darwin"'
+     ```
+
+6. 运行脚本构建.
+
+   ```shell
+   ./oss_scripts/run_build.sh
+   ```
+
+## Tips&Refer
+
+1. `text`需要和`tensorflow`的次要版本对应(比如`tensorflow-macos==2.7.0`和`tensorflow-text==2.7.3`)
+2. 编译过程中请保证你的网络稳定, 编译需要使用网络.
+3. [本人添加Apple Silicon支持的PR.](https://github.com/tensorflow/text/pull/756)
+

tutorials/text/text.md

@@ -0,0 +1,73 @@
+# Build TensorFlow Text from source
+
+## Necessary conditions
+
+It is assumed here that you have the necessary Unix-Like knowledge, [`brew`](https://brew.sh) and [`conda`](https://github.com/conda-forge/miniforge) have been installed in your terminal, and the installation and use methods of `brew` and `conda` will not be repeated here; most importantly, this tutorial is completely based on Apple Silicon (such as M1, M1 Pro or M1 Max) build, so make sure your Mac is Apple Silicon.
+
+## Step by Step
+
+1. Create a new Env and install the dependencies provided by Apple.
+
+   ```shell
+   conda create -n tensorflow-macos python=3.9 # 这里Python版本也可以使用Python 3.8
+   conda activate tensorflow-macos
+   conda install -c apple tensorflow-deps==2.8.0
+   ````
+
+2. Install the `tensorflow-macos` and `tensorflow-metal` plugins.
+
+   ```shell
+   pip install tensorflow-macos
+   pip install tensorflow-metal
+   ````
+
+3. Install `bazel 4.2.2`.
+
+   ```shell
+   wget https://raw.githubusercontent.com/Homebrew/homebrew-core/210bef2d570f0635e07009f4c5242b5e6645ae31/Formula/bazel.rb
+   brew install ./bazel.rb
+   bazel --version # make sure the version is 4.2.2
+   ````
+
+   * Usually, the `bazel` installed by `brew` will be the latest version. The latest version often does not match the version required by `text`, which may cause many unexpected problems, so we install it by specifying the version manually.
+
+4. Download and extract `text 2.8.1`.
+
+   ```shell
+   wget https://github.com/tensorflow/text/archive/refs/tags/v2.8.1.zip
+   unzip ./v2.8.1.zip
+   cd text-2.8.1
+   ````
+
+5. Modify some parameters of the source code to ensure correct build.
+
+   * `oss_scripts/configure.sh` to modify line 49:
+
+     ```shell
+     pip install tensorflow-macos==2.8.0
+     ````
+
+   * `oss_scripts/run_build.sh` comment out line 17:
+
+     ```shell
+     # source oss_scripts/prepare_tf_dep.sh
+     ````
+
+   * `oss_scripts/pip_package/setup.py` modify behavior 76, 77:
+
+     ````python
+     'tensorflow>=2.8.0, <2.9.0; platform_machine != "arm64" or platform_system != "Darwin"',
+     'tensorflow-macos>=2.8.0, <2.9.0; platform_machine == "arm64" and platform_system == "Darwin"'
+     ````
+
+6. Run the script.
+
+   ```shell
+   ./oss_scripts/run_build.sh
+   ````
+
+## Tips&Refer
+
+1. `text` needs to correspond to a minor version of `tensorflow` (eg `tensorflow-macos==2.7.0` and `tensorflow-text==2.7.3`)
+2. Please ensure that your network is stable during the compilation process, and the compilation needs to use the network.
+3. [I add a PR for Apple Silicon support.](https://github.com/tensorflow/text/pull/756)