Update the plugin docs for the new plugins. (#118)

Signed-off-by: YiYing He <[email protected]>

Author: q82419

docs/contribute/plugin/intro.md

@@ -26,16 +26,18 @@ There are several plug-in releases with the WasmEdge official releases. Please c
 
 | Plug-in | Rust Crate | Released Platforms | Build Steps |
 | --- | --- | --- | --- |
-| WasmEdge-Process | [wasmedge_process_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.0`) | [Default](/contribute/source/os/linux) |
-| [WASI-Crypto] | [wasi-crypto][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-Crypto](/contribute/source/plugin/wasi_crypto) |
-| [WASI-NN with OpenVINO backend](/develop/rust/ai_inference/openvino) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-NN](/contribute/source/plugin/was_nn#get-wasmedge-with-wasi-nn-plug-in-openvino-backend) |
-| [WASI-NN with PyTorch backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.11.1`) | [Build With WASI-NN](/contribute/source/plugin/was_nn#build-wasmedge-with-wasi-nn-pytorch-backend) |
-| [WASI-NN with TensorFlow-Lite backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.11.2`) | [Build With WASI-NN](/contribute/source/plugin/was_nn#build-wasmedge-with-wasi-nn-tensorflow-lite-backend) |
-| [WasmEdge-HttpsReq] | [wasmedge_http_req][] | `manylinux2014 x86_64`, and `manylinux2014 aarch64` (since `0.11.1`) | [Build With WasmEdge-HttpsReq](/contribute/source/plugin/httpsreq) |
+| WasmEdge-Process | [wasmedge_process_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.0`) | [Build Wtih WasmEdge-Process](/contribute/source/plugin/process) |
+| [WASI-Crypto][] | [wasi-crypto][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-Crypto](/contribute/source/plugin/wasi_crypto) |
+| [WASI-NN with OpenVINO backend](/develop/rust/ai_inference/openvino) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#get-wasmedge-with-wasi-nn-plug-in-openvino-backend) |
+| [WASI-NN with PyTorch backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.11.1`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-pytorch-backend) |
+| [WASI-NN with TensorFlow-Lite backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.11.2`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-tensorflow-lite-backend) |
+| WasmEdge-Image | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Image](/contribute/source/plugin/image) |
+| WasmEdge-Tensorflow | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Tensorflow](/contribute/source/plugin/tensorflow) |
+| WasmEdge-TensorflowLite | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-TensorflowLite](/contribute/source/plugin/tensorflowlite) |
 
-> Due to the `OpenVINO` and `PyTorch` dependencies, we only release the WASI-NN plug-in on `Ubuntu 20.04 x86_64` now. We'll work with `manylinux2014` versions in the future.
+> Due to the `OpenVINO` dependency, we only release the WASI-NN plug-in for the `OpenVINO` backend on `Ubuntu 20.04 x86_64` now. We'll work with `manylinux2014` versions in the future.
 
 [wasmedge_process_interface]: https://crates.io/crates/wasmedge_process_interface
+[wasmedge_tensorflow_interface]: https://crates.io/crates/wasmedge_tensorflow_interface
 [wasi-crypto]: https://crates.io/crates/wasi-crypto
 [wasi-nn]: https://crates.io/crates/wasi-nn
-[wasmedge_http_req]: https://crates.io/crates/wasmedge_http_req

docs/contribute/source/build_from_src.md

@@ -16,7 +16,10 @@ Please follow this guide to build and test WasmEdge from the source code.
 - [seL4](../source/os/sel4)
 - [Raspberry Pi](../source/os/raspberrypi.md)
 
-> If you just want the latest builds from the `HEAD` of the `master` branch, and do not want to build it yourself, you can download the release package directly from our Github Action's CI artifact. [Here is an example](https://github.com/WasmEdge/WasmEdge/actions/runs/1521549504#artifacts).
+<!-- prettier-ignore -->
+:::note
+If you just want the latest builds from the `HEAD` of the `master` branch, and do not want to build it yourself, you can download the release package directly from our Github Action's CI artifact. [Here is an example](https://github.com/WasmEdge/WasmEdge/actions/runs/1521549504#artifacts).
+:::
 
 ## What Will Be Built
 
@@ -55,24 +58,37 @@ Developers can set the CMake options to customize the WasmEdge building.
    - If this option and the option `WASMEDGE_LINK_TOOLS_STATIC` are both set as `ON`, the `WASMEDGE_LINK_LLVM_STATIC` and `WASMEDGE_BUILD_STATIC_LIB` will both be set as `ON`, and the `wasmedge` and `wasmedgec` tools will link to the WasmEdge static library instead. In this case, the plugins will not work in tools.
 6. `WASMEDGE_BUILD_PLUGINS`: build the WasmEdge plugins. Default is `ON`.
 7. `WASMEDGE_BUILD_EXAMPLE`: build the WasmEdge examples. Default is `OFF`.
-8. `WASMEDGE_PLUGIN_WASI_NN_BACKEND`: build the WasmEdge WASI-NN plugin (Linux platforms only). Default is empty.
-   - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
-   - To build the WASI-NN plugin with backend, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name>`.
-   - To build the WASI-NN plugin with multiple backends, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name1>,<backend_name2>`.
-9. `WASMEDGE_PLUGIN_WASI_CRYPTO`: build the WasmEdge WASI-Crypto plugin (Linux platforms only). Default is `OFF`.
-   - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
-10. `WASMEDGE_FORCE_DISABLE_LTO`: forcefully turn off the link time optimization. Default is `OFF`.
-11. `WASMEDGE_LINK_LLVM_STATIC`: link the LLVM and lld libraries statically (Linux and MacOS platforms only, experimental). Default is `OFF`.
-12. `WASMEDGE_LINK_TOOLS_STATIC`: make the `wasmedge` and `wasmedgec` tools to link the WasmEdge library and LLVM libraries statically (Linux and MacOS platforms only, experimental). Default is `OFF`.
+8. `WASMEDGE_FORCE_DISABLE_LTO`: forcefully turn off the link time optimization. Default is `OFF`.
+9. `WASMEDGE_LINK_LLVM_STATIC`: link the LLVM and lld libraries statically (Linux and MacOS platforms only). Default is `OFF`.
+10. `WASMEDGE_LINK_TOOLS_STATIC`: make the `wasmedge` and `wasmedgec` tools to link the WasmEdge library and LLVM libraries statically (Linux and MacOS platforms only). Default is `OFF`.
     - If the option `WASMEDGE_BUILD_TOOLS` and this option are both set as `ON`, the `WASMEDGE_LINK_LLVM_STATIC` will be set as `ON`.
+11. `WASMEDGE_ENABLE_UB_SANITIZER`: enable the undefined behavior sanitizer. Default is `OFF`.
+12. `WASMEDGE_PLUGIN_WASI_NN_BACKEND`: build the WasmEdge WASI-NN plugin (Linux platforms only). Default is empty.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+    - To build the WASI-NN plugin with backend, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name>`.
+    - To build the WASI-NN plugin with multiple backends, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name1>,<backend_name2>`.
+13. `WASMEDGE_PLUGIN_WASI_CRYPTO`: build the WasmEdge WASI-Crypto plugin (Linux and MacOS platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+14. `WASMEDGE_PLUGIN_WASI_LOGGING`: build the WasmEdge WASI-Logging plugin (Linux and MacOS platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+15. `WASMEDGE_PLUGIN_WASM_BPF`: build the WasmEdge wasm_bpf plugin (Linux platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+16. `WASMEDGE_PLUGIN_IMAGE`: build the WasmEdge image plugin (Linux and MacOS platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+17. `WASMEDGE_PLUGIN_TENSORFLOW`: build the WasmEdge TensorFlow plugin (Linux and MacOS platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
+18. `WASMEDGE_PLUGIN_TENSORFLOWLITE`: build the WasmEdge TensorFlow-Lite plugin (Linux and MacOS platforms only). Default is `OFF`.
+    - This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
 
 ## Build WasmEdge with Plug-ins
 
 Developers can follow the steps to build WasmEdge with plug-ins from source.
 
-- [WASI-NN (OpenVINO and PyTorch backends)](../source/plugin/was_nn.md)
+- [WASI-NN (OpenVINO, PyTorch, or TensorFlow-Lite backends)](../source/plugin/wasi_nn.md)
 - [WASI-Crypto](../source/plugin/wasi_crypto.md)
-- [WasmEdge-HttpsReq](../source/plugin/httpsreq.md)
+- [WasmEdge-Image](../source/plugin/image.md)
+- [WasmEdge-TensorFlow](../source/plugin/tensorflow.md)
+- [WasmEdge-TensorFlowLite](../source/plugin/tensorflowlite.md)
 
 ## Run Tests
 

docs/contribute/source/os/macos.md

@@ -7,9 +7,10 @@ sidebar_position: 2
 Currently, WasmEdge project on MacOS supports both Intel and M1 models. However, we only test and develop on `Catalina`, `Big Sur`, and `Monterey`.
 
 - Model:
-  - Intel
-  - M1
+  - Intel (x86_64)
+  - M1, M2 (arm64)
 - Operating System
+  - Ventura
   - Monterey
   - Big Sur
   - Catalina
@@ -27,11 +28,11 @@ cd WasmEdge
 
 WasmEdge will try to use the latest LLVM release to create our nightly build. If you want to build from source, you may need to install these dependencies by yourself.
 
-- LLVM 14.0.1 (>= 10.0.0)
+- LLVM 16.0.4 (>= 10.0.0)
 
 ```bash
 # Tools and libraries
-brew install boost cmake ninja llvm
+brew install cmake ninja llvm
 export LLVM_DIR="$(brew --prefix)/opt/llvm/lib/cmake"
 export CC=clang
 export CXX=clang++

docs/contribute/source/plugin/ebpf.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 7
 ---
 
 # Build with eBPF Plugin

docs/contribute/source/plugin/httpsreq.md

@@ -0,0 +1,41 @@
+---
+sidebar_position: 4
+---
+
+# Build WasmEdge With WasmEdge-Image Plug-in
+
+## Prerequisites
+
+The prerequisites of the WasmEdge-Image plug-in is the same as the WasmEdge building environment on the [Linux platforms](../os/linux.md) or [MacOS platforms](../os/macos.md).
+
+If developers build with their own environment, please ensure the `zlib` are installed.
+
+```bash
+sudo apt update
+sudo apt install zlib1g-dev
+```
+
+On MacOS platforms, the `libjpeg` and `libpng` are required.
+
+```bash
+brew install jpeg-turbo libpng
+```
+
+## Build WasmEdge with WasmEdge-Image Plug-in
+
+To enable the WasmEdge WasmEdge-Image, developers need to [building the WasmEdge from source](../build_from_src.md) with the cmake option `-DWASMEDGE_PLUGIN_IMAGE=On`.
+
+```bash
+cd <path/to/your/wasmedge/source/folder>
+cmake -GNinja -Bbuild -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_IMAGE=On
+cmake --build build
+# For the WasmEdge-Image plugin, you should install this project.
+cmake --install build
+```
+
+<!-- prettier-ignore -->
+:::note
+If the built `wasmedge` CLI tool cannot find the WasmEdge-Image plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (such as `/usr/local/lib/wasmedge/`, or the built plug-in path `build/plugins/wasmedge_image/`) to try to fix this issue.
+:::
+
+Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and the WasmEdge-Image plug-in under `/usr/local/lib/wasmedge/libwasmedgePluginWasmEdgeImage.so` after installation.

docs/contribute/source/plugin/image.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 3
 ---
 
 # Build WasmEdge With WasmEdge-Process Plug-in
@@ -10,16 +10,19 @@ The prerequisites of the WasmEdge-Process plug-in is the same as the [WasmEdge b
 
 ## Build WasmEdge with WasmEdge-Process Plug-in
 
-To enable the WasmEdge WasmEdge-HttpsReq, developers need to [building the WasmEdge from source](../build_from_src.md) with the cmake option `-DWASMEDGE_PLUGIN_PROCESS=On`.
+To enable the WasmEdge WasmEdge-Process, developers need to [building the WasmEdge from source](../build_from_src.md) with the cmake option `-DWASMEDGE_PLUGIN_PROCESS=On`.
 
 ```bash
 cd <path/to/your/wasmedge/source/folder>
-mkdir -p build && cd build
-cmake -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_PROCESS=On .. && make -j
-# For the WasmEdge-HttpsReq plugin, you should install this project.
-cmake --install .
+cmake -GNinja -Bbuild -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_PROCESS=On
+cmake --build build
+# For the WasmEdge-Process plugin, you should install this project.
+cmake --install build
 ```
 
-> If the built `wasmedge` CLI tool cannot find the WasmEdge-Process plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (`/usr/local/lib/wasmedge/`, or the built plug-in path `build/plugins/wasmedge_process/`) to try to fix this issue.
+<!-- prettier-ignore -->
+:::note
+If the built `wasmedge` CLI tool cannot find the WasmEdge-Process plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (such as `/usr/local/lib/wasmedge/`, or the built plug-in path `build/plugins/wasmedge_process/`) to try to fix this issue.
+:::
 
 Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and the WasmEdge-Process plug-in under `/usr/local/lib/wasmedge/libwasmedgePluginWasmEdgeProcess.so` after installation.

docs/contribute/source/plugin/process.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 8
 ---
 
 # Build with Rusttls Plugin

docs/contribute/source/plugin/rusttls.md

@@ -0,0 +1,72 @@
+---
+sidebar_position: 5
+---
+
+# Build WasmEdge With WasmEdge-Tensorflow Plug-in
+
+## Prerequisites
+
+The prerequisites of the WasmEdge-Tensorflow plug-in is the same as the WasmEdge building environment on the [Linux platforms](../os/linux.md) or [MacOS platforms](../os/macos.md).
+
+## Build WasmEdge with WasmEdge-Tensorflow Plug-in
+
+To enable the WasmEdge WasmEdge-Tensorflow, developers need to [building the WasmEdge from source](../build_from_src.md) with the cmake option `-DWASMEDGE_PLUGIN_TENSORFLOW=On`.
+
+```bash
+cd <path/to/your/wasmedge/source/folder>
+cmake -GNinja -Bbuild -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_TENSORFLOW=On
+cmake --build build
+# For the WasmEdge-Tensorflow plugin, you should install this project.
+cmake --install build
+```
+
+<!-- prettier-ignore -->
+:::note
+If the built `wasmedge` CLI tool cannot find the WasmEdge-Tensorflow plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (such as `/usr/local/lib/wasmedge/`, or the built plug-in path `build/plugins/wasmedge_tensorflow/`) to try to fix this issue.
+:::
+
+Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and the WasmEdge-Tensorflow plug-in under `/usr/local/lib/wasmedge/libwasmedgePluginWasmEdgeTensorflow.so` after installation.
+
+## Install the TensorFlow Dependency
+
+Installing the necessary `libtensorflow_cc.so` and `libtensorflow_framework.so` on both `Linux` and `MacOS` platforms, we recommend the following commands:
+
+```bash
+curl -s -L -O --remote-name-all https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/TF-2.12.0-CC/WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
+# For the Linux aarch64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-manylinux2014_aarch64.tar.gz`.
+# For the MacOS x86_64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-darwin_x86_64.tar.gz`.
+# For the MacOS arm64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-darwin_arm64.tar.gz`.
+tar -zxf WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
+rm -f WasmEdge-tensorflow-deps-TF-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
+```
+
+The shared library will be extracted in the current directory `./libtensorflow_cc.so.2.12.0` and `./libtensorflow_framework.so.2.12.0` on `Linux` platforms, or `./libtensorflow_cc.2.12.0.dylib` and `./libtensorflow_framework.2.12.0.dylib` on `MacOS` platforms.
+
+<!-- prettier-ignore -->
+:::note
+After building the plug-in, you can also find these shared libraries under the `build/_deps/wasmedge_tensorflow_lib_tf-src/` directory.
+:::
+
+Then you can move the library to the installation path and create the symbolic link:
+
+```bash
+mv libtensorflow_cc.so.2.12.0 /usr/local/lib
+mv libtensorflow_framework.so.2.12.0 /usr/local/lib
+ln -s libtensorflow_cc.so.2.12.0 /usr/local/lib/libtensorflow_cc.so.2
+ln -s libtensorflow_cc.so.2 /usr/local/lib/libtensorflow_cc.so
+ln -s libtensorflow_framework.so.2.12.0 /usr/local/lib/libtensorflow_framework.so.2
+ln -s libtensorflow_framework.so.2 /usr/local/lib/libtensorflow_framework.so
+```
+
+If on `MacOS` platforms:
+
+```bash
+mv libtensorflow_cc.2.12.0.dylib /usr/local/lib
+mv libtensorflow_framework.2.12.0.dylib /usr/local/lib
+ln -s libtensorflow_cc.2.12.0.dylib /usr/local/lib/libtensorflow_cc.2.dylib
+ln -s libtensorflow_cc.2.dylib /usr/local/lib/libtensorflow_cc.dylib
+ln -s libtensorflow_framework.2.12.0.dylib /usr/local/lib/libtensorflow_framework.2.dylib
+ln -s libtensorflow_framework.2.dylib /usr/local/lib/libtensorflow_framework.dylib
+```
+
+Or create the symbolic link in the current directory and set the environment variable `export LD_LIBRARY_PATH=$(pwd):${LD_LIBRARY_PATH}`.