Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
WASMEDGE_VERSION='0.17.2'
WASMEDGE_VERSION='0.18.0'
WASMEDGE_GO_VERSION='0.14.0'
39 changes: 7 additions & 32 deletions docs/contribute/installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ The actual installer handles all stuff. It supports python2.7 (not tested on ear
- Description: Install the given VERSION of WasmEdge
- Available Value: VERSION `{{ wasmedge_version }}` or other valid release versions.
- Note - If supplied an invalid or nonexistent version, the installer exits with an error.
- Note - The installer only supports installing WasmEdge `0.13.0` and the later versions.

### Installation path

Expand All @@ -74,6 +75,11 @@ The actual installer handles all stuff. It supports python2.7 (not tested on ear
- Note - Any paths other than the ones starting with `/usr` are treated as non-system paths in the internals of the installer. The consequences are different directory structures for both.
- Note - If the path not exists, the folder will be created.

### Skip modifying the shell profiles

- Full Option: `--no-modify-shell-profile`
- Description: Do not modify the shell profile or startup files. Users should source the generated `$INSTALLATION_PATH/env` file manually.

### Uninstallation

#### Run uninstaller before installing
Expand All @@ -88,42 +94,11 @@ The actual installer handles all stuff. It supports python2.7 (not tested on ear
- Full Option: `--uninstall-script-tag UNINSTALL_SCRIPT_TAG`
- Description: Use the given GitHub tag to uninstall the script

### Install Extensions

- Short Option: `-e [EXTENSIONS [EXTENSIONS ...]]`
- Full Option: `--extension [EXTENSIONS [EXTENSIONS ...]]`
- Description: Install wasmedge-extension tools.
- Available Value (case sensitive): Supported Extensions `'tensorflow', 'image', 'all'`.

#### Tensorflow Extensions Library Version

- Full Option: `--tf-version TF_VERSION`
- Description: Install the given VERSION of the library of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
- Note - It's the same as the WasmEdge version if not specified.

#### Tensorflow Extensions Dependencies Version

- Full Option: `--tf-deps-version TF_DEPS_VERSION`
- Description: Install the given VERSION of the dependencies of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
- Note - It's the same as the WasmEdge version if not specified.

#### Tensorflow Extensions Tools Version

- Full Option: `--tf-tools-version TF_TOOLS_VERSION`
- Description: Install the given VERSION of the tools of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
- Note - It's the same as the WasmEdge version if not specified.

#### Image Extensions Version

- Full Option: `--image-version IMAGE_VERSION`
- Description: Install the given VERSION of the Image extension. Only available when the `Extensions` is set to `all` or `image`.
- Note - It's the same as the WasmEdge version if not specified.

### Plugins

- Note - Currently, `--plugins` is an experimental option.

- Full Option: `--plugins wasi_crypto:0.12.0`
- Full Option: `--plugins wasi_crypto:0.13.0`

- Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example, `--plugins wasi_crypto` is a valid option.
- Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](plugin/intro.md) in the `Rust Crate` column. The logic is that the release name should be the same.
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/source/build_from_src.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Developers can set the CMake options to customize the WasmEdge building.

<!-- prettier-ignore -->
:::note
Since WasmEdge `0.17.2`, the build uses the system `blake3` library when it is available, and falls back to the vendored copy otherwise. Developers can set `-DCMAKE_DISABLE_FIND_PACKAGE_blake3=ON` to force the vendored copy. When the option `WASMEDGE_BUILD_STATIC_LIB` is set as `ON`, the vendored copy is always used.
The build uses the system `blake3` library when it is available, and falls back to the vendored copy otherwise. Developers can set `-DCMAKE_DISABLE_FIND_PACKAGE_blake3=ON` to force the vendored copy. When the option `WASMEDGE_BUILD_STATIC_LIB` is set as `ON`, the vendored copy is always used.
:::

## Build WasmEdge with Plug-ins
Expand Down
7 changes: 6 additions & 1 deletion docs/contribute/source/plugin/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ sidebar_position: 3

# Build WasmEdge With WasmEdge-Process Plug-in

<!-- prettier-ignore -->
:::note
The WasmEdge-Process plug-in is removed since WasmEdge `0.18.0`. This guide only applies to WasmEdge `0.17.2` and the earlier versions.
:::

The WasmEdge Process plug-in provides a sandboxed environment to execute system processes in a secured manner. This guide will walk you through the steps to build the WasmEdge Process plug-in.

## Prerequisites
Expand Down Expand Up @@ -41,4 +46,4 @@ Replace `your_wasm_file.wasm` with the path to your WebAssembly file. The `--pro

That's it! You have successfully built and installed the WasmEdge Process plug-in.

For more information, you can refer to the [GitHub repository](https://github.com/WasmEdge/WasmEdge/tree/master/plugins/wasmedge_process).
For more information, you can refer to the [GitHub repository](https://github.com/WasmEdge/WasmEdge/tree/0.17.x/plugins/wasmedge_process).
26 changes: 11 additions & 15 deletions docs/contribute/source/plugin/tensorflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and t
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
curl -s -L -O --remote-name-all https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/TF-2.21.0-CC/WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
# For the Linux aarch64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-manylinux_2_28_aarch64.tar.gz`.
# For the MacOS x86_64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-darwin_x86_64.tar.gz`.
# For the MacOS arm64 platforms, please use the `WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-darwin_arm64.tar.gz`.
tar -zxf WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
rm -f WasmEdge-tensorflow-deps-TF-TF-2.21.0-CC-manylinux_2_28_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.
The shared library will be extracted in the current directory `./libtensorflow_cc.so.2` and `./libtensorflow_framework.so.2` on `Linux` platforms, or `./libtensorflow_cc.2.dylib` and `./libtensorflow_framework.2.dylib` on `MacOS` platforms.

<!-- prettier-ignore -->
:::note
Expand All @@ -52,22 +52,18 @@ After building the plug-in, you can also find these shared libraries under the `
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
mv libtensorflow_cc.so.2 /usr/local/lib
mv libtensorflow_framework.so.2 /usr/local/lib
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
mv libtensorflow_cc.2.dylib /usr/local/lib
mv libtensorflow_framework.2.dylib /usr/local/lib
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
```

Expand Down
12 changes: 6 additions & 6 deletions docs/contribute/source/plugin/tensorflowlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and t
Installing the necessary `libtensorflowlite_c.so` and `libtensorflowlite_flex.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-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
# For the Linux aarch64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-manylinux2014_aarch64.tar.gz`.
# For the MacOS x86_64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-darwin_x86_64.tar.gz`.
# For the MacOS arm64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-darwin_arm64.tar.gz`.
tar -zxf WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
rm -f WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
curl -s -L -O --remote-name-all https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/TF-2.21.0-CC/WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
# For the Linux aarch64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_aarch64.tar.gz`.
# For the MacOS x86_64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-darwin_x86_64.tar.gz`.
# For the MacOS arm64 platforms, please use the `WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-darwin_arm64.tar.gz`.
tar -zxf WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
rm -f WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
```

The shared library will be extracted in the current directory `./libtensorflowlite_c.so` and `./libtensorflowlite_flex.so` on `Linux` platforms, or `./libtensorflowlite_c.dylib` and `./libtensorflowlite_flex.dylib` on `MacOS` platforms.
Expand Down
8 changes: 4 additions & 4 deletions docs/contribute/source/plugin/wasi_nn.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ cmake -GNinja -Bbuild -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_WASI_NN_BACKE
cmake --build build
```

Installing the necessary `libtensorflowlite_c.so` and `libtensorflowlite_flex.so` on both `Ubuntu 20.04` and `manylinux2014` for the backend, we recommend the following commands:
Installing the necessary `libtensorflowlite_c.so` and `libtensorflowlite_flex.so` on both `Ubuntu 20.04` and `manylinux_2_28` for the backend, 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-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
tar -zxf WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
rm -f WasmEdge-tensorflow-deps-TFLite-TF-2.12.0-CC-manylinux2014_x86_64.tar.gz
curl -s -L -O --remote-name-all https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/TF-2.21.0-CC/WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
tar -zxf WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
rm -f WasmEdge-tensorflow-deps-TFLite-TF-2.21.0-CC-manylinux_2_28_x86_64.tar.gz
```

The shared library will be extracted in the current directory `./libtensorflowlite_c.so` and `./libtensorflowlite_flex.so`.
Expand Down
7 changes: 1 addition & 6 deletions docs/contribute/source/plugin/wasmedge_opencvmini.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The WasmEdge-OpenCVMini plug-in exposes a subset of [OpenCV](https://opencv.org/

## Prerequisites

Since WasmEdge `0.17.2`, the plug-in requires OpenCV 5. Please install OpenCV 5 on your system.
Install OpenCV 5 on your system.

For macOS:

Expand All @@ -18,11 +18,6 @@ brew install opencv@5

For Linux, the `libopencv-dev` package of most distributions still provides OpenCV 4. Please build and install OpenCV 5 from the [OpenCV source](https://github.com/opencv/opencv) instead.

<!-- prettier-ignore -->
:::note
For WasmEdge `0.17.1` and earlier versions, the plug-in requires OpenCV 4, which can be installed by `sudo apt install -y libopencv-dev` on Ubuntu or `brew install opencv` on macOS.
:::

## Build WasmEdge with WasmEdge-OpenCVMini Plug-in

To enable the WasmEdge-OpenCVMini plug-in, developers need to [build WasmEdge from source](https://github.com/WasmEdge/docs/blob/main/docs/contribute/source/os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_OPENCVMINI=ON`.
Expand Down
5 changes: 5 additions & 0 deletions docs/develop/rust/command.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ sidebar_position: 11

# Command interface

<!-- prettier-ignore -->
:::note
The command interface relies on the WasmEdge-Process plug-in, which is removed since WasmEdge `0.18.0`. This guide only applies to WasmEdge `0.17.2` and the earlier versions.
:::

WASI enables WebAssembly programs to call standard library functions in the host operating system. It does so through a fine-grained security model known as “capability-based security”. The WebAssembly VM owner can grant access to host system resources when the VM starts. The program cannot access resources (e.g., file folders) that are not explicitly allowed.

Now, why limit ourselves to standard library functions? The same approach can call just any host function from WebAssembly. WasmEdge provides a WASI-like extension to access command line programs in the host operating system.
Expand Down
3 changes: 2 additions & 1 deletion docs/embed/c/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,8 @@ sys 0m0.011s

## API References

- [0.17.2](reference/latest.md)
- [0.18.0](reference/latest.md)
- [0.17.2](reference/0.17.x.md)
- [0.16.3](reference/0.16.x.md)
- [0.15.1](reference/0.15.x.md)
- [0.14.1](reference/0.14.x.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.10.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 15
sidebar_position: 17
---

# C API 0.10.1 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.11.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 13
sidebar_position: 15
---

# C API 0.11.2 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.12.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 13
---

# C API 0.12.1 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.13.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 11
---

# C API 0.13.5 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.14.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 9
---

# C API 0.14.1 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.15.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 7
---

# C API 0.15.1 Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/c/reference/0.16.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 5
---

# C API 0.16.3 Documentation
Expand Down
Loading
Loading