You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repo contains technical documentation for the [WasmEdge Runtime](https://github.com/WasmEdge/WasmEdge) project. The documentation website built from this repo is published https://wasmedge.org/docs/, check it out!
This repo contains technical documentation for the [WasmEdge Runtime](https://github.com/WasmEdge/WasmEdge) project. The documentation website built from this repo is published <https://wasmedge.org/docs/>, check it out!
6
6
7
-
# Setting up the Docs Locally
7
+
##Setting up the Docs Locally
8
8
9
9
To set up the WasmEdge Docs locally, you will need to follow these general steps:
10
10
11
11
1.**Clone the project:** Go to the GitHub repository page of the WasmEdge Docs project and click on the "Code" button to get the URL of the repository. Then, open a terminal or command prompt and type the following command:
12
12
13
-
```bash
14
-
git clone https://github.com/WasmEdge/docs.git
15
-
```
13
+
```bash
14
+
git clone https://github.com/WasmEdge/docs.git
15
+
```
16
16
17
17
2.**Install dependencies:** Navigate to the project directory in the terminal and run the following command to install the necessary dependencies:
18
18
19
-
```bash
20
-
npm install
21
-
```
19
+
```bash
20
+
npm install
21
+
```
22
22
23
23
3.**Start the development server:** Once the dependencies are installed, you can start the development server by running the following command:
24
24
25
-
```bash
26
-
npm start
27
-
```
25
+
```bash
26
+
npm start
27
+
```
28
28
29
-
This should start the development server on port 3000. You can access the running application by opening a web browser and navigating to http://localhost:3000/docs/.
29
+
This should start the development server on port 3000. You can access the running application by opening a web browser and navigating to <http://localhost:3000/docs/>.
30
30
31
31
That's it! You should now have a local instance of the WasmEdge Docs running on your machine.
Copy file name to clipboardexpand all lines: docs/contribute/contribute.md
+4-3
Original file line number
Diff line number
Diff line change
@@ -20,14 +20,15 @@ Pull requests are always welcome, even if they only contain small fixes like typ
20
20
21
21
Please submit a pull request broken down into small changes bit by bit. A pull request consisting of a lot features and code changes may be hard to review. It is recommended to submit pull requests in an incremental fashion.
22
22
23
-
> If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete.
23
+
<!-- prettier-ignore -->
24
+
:::note
25
+
If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete.
26
+
:::
24
27
25
28
### Fork and Clone the Repository
26
29
27
30
Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace
28
31
29
-
> The WasmEdge team builds lots of extensions of Server-side WebAssembly, like [TensorFlow](https://github.com/second-state/WasmEdge-tensorflow), [Storage](https://github.com/second-state/WasmEdge-storage), [Command interface] and so on. If you want to contribute to the extensions, please check out [the details here](../develop/wasmedge/extensions/unique_extensions).
30
-
31
32
### Branches and Commits
32
33
33
34
Changes should be made on your own fork in a new branch. Pull requests should be rebased on the top of master.
Copy file name to clipboardexpand all lines: docs/contribute/installer.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
sidebar_position: 7
3
3
---
4
4
5
-
# Installer System explanation
5
+
# Installer Guide
6
6
7
7
## Overview
8
8
9
-
WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasmedgec`), the Libraries (`libwasmedge`), the Extensions(`wasmedge-tensorflow`), and the Plugins(`wasi-nn`, `wasi-crytpo`).
9
+
WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasmedge compile`), the Libraries (`libwasmedge`), the Extensions(`wasmedge-tensorflow`), and the Plugins(`wasi-nn`, `wasi-crytpo`).
10
10
11
11
## Dependencies
12
12
@@ -63,7 +63,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
63
63
- Short Option: `-v VERSION`
64
64
- Full Option: `--version VERSION`
65
65
- Description: Install the given VERSION of WasmEdge
66
-
- Available Value: VERSION `0.11.2` or other valid release versions.
66
+
- Available Value: VERSION `{{ wasmedge_version }}` or other valid release versions.
67
67
- Note - In the case of supplied an invalid or nonexistent version, the installer exists with an error.
68
68
69
69
### Installation path
@@ -123,7 +123,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
123
123
124
124
- Note - Currently `--plugins` is an experimental option.
125
125
126
-
- Full Option: `--plugins wasi_crypto:0.11.0`
126
+
- Full Option: `--plugins wasi_crypto:0.12.0`
127
127
128
128
- 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.
129
129
- Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](https://wasmedge.org/docs/contribute/plugin/intro) in the `Rust Crate` column. The logic is that the release name should be the same.
Copy file name to clipboardexpand all lines: docs/contribute/plugin/develop_plugin_c.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,12 @@ Assume that the plug-in example is in the file `testplugin.c`.
18
18
19
19
The goal of the plug-in is to provide the host functions which can be imported when instantiating WASM.
20
20
21
-
Therefore, developers can implement their plug-in host functions first, as the same as the [host functions in WasmEdge C API](/embed/c/reference/0.12.0.md#host-functions).
21
+
Therefore, developers can implement their plug-in host functions first, as the same as the [host functions in WasmEdge C API](/embed/c/reference/latest.md#host-functions).
22
22
23
-
> For the more details about the [external data](/embed/c/host_function.md#host-data) and [calling frame context](/embed/c/host_function.md#calling-frame-context), please refer to the host function guide.
23
+
<!-- prettier-ignore -->
24
+
:::note
25
+
For the more details about the [external data](/embed/c/host_function.md#host-data) and [calling frame context](/embed/c/host_function.md#calling-frame-context), please refer to the host function guide.
Copy file name to clipboardexpand all lines: docs/contribute/plugin/intro.md
+4-3
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,6 @@ Please [refer to the plugin example code](https://github.com/WasmEdge/WasmEdge/t
22
22
23
23
There are several plug-in releases with the WasmEdge official releases. Please check the following table to check the release status and how to build from source with the plug-ins.
24
24
25
-
> The `WasmEdge-Process` plug-in is attached in the WasmEdge release tarballs.
@@ -35,7 +33,10 @@ There are several plug-in releases with the WasmEdge official releases. Please c
35
33
| 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)|
36
34
| 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)|
37
35
38
-
> 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.
36
+
<!-- prettier-ignore -->
37
+
:::note
38
+
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.
Copy file name to clipboardexpand all lines: docs/contribute/source/os/android/cli.md
+9-4
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,11 @@ sidebar_position: 2
6
6
7
7
In this section, we will show you how to use WasmEdge CLI tools on Android devices. We will showcase a full WasmEdge demo to perform image classification (Tensorflow-based AI inference) on an Android device.
8
8
9
+
<!-- prettier-ignore -->
10
+
:::note
11
+
The `WasmEdge-tensorflow-tools` has been deprecated after the 0.12.1 version. We'll update to use the WasmEdge plug-in in the future.
12
+
:::
13
+
9
14
## Install Android version of WasmEdge-TensorFlow-Tools
10
15
11
16
First, install WasmEdge-TensorFlow-Tools pre-release on your Android device. It works with the Android version of TensorFlow-Lite dynamic shared library.
@@ -36,8 +41,8 @@ sirius:/ $
36
41
Use the following commands on your Ubuntu dev machine to download the WasmEdge-TensorFlow-Tools pre-release packages.
$ mkdir WasmEdge-tensorflow-tools && tar zxvf WasmEdge-tensorflow-tools-0.12.1-android_aarch64.tar.gz -C WasmEdge-tensorflow-tools
41
46
show-tflite-tensor
42
47
wasmedge-tensorflow-lite
43
48
```
@@ -47,8 +52,8 @@ wasmedge-tensorflow-lite
47
52
We provide an Android compatible version of TensorFlow-Lite dynamic shared library in the WasmEdge-Tensorflow-deps package. Download the package to your Ubuntu dev machine as follows.
Copy file name to clipboardexpand all lines: docs/contribute/source/os/android/ndk.md
+15-10
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,11 @@ sidebar_position: 3
6
6
7
7
In this section, we will demonstrate how to build an Android native application using C and the Android SDK. The native application uses the WasmEdge C SDK to embed the WasmEdge Runtime, and call WASM functions through WasmEdge.
8
8
9
+
<!-- prettier-ignore -->
10
+
:::note
11
+
The `WasmEdge-Image`, `WasmEdge-Tensorflow`, and `WasmEdge-tensorflow-tools` have been deprecated after the 0.12.1 version. We'll update to use the WasmEdge plug-in in the future.
12
+
:::
13
+
9
14
## Prerequisite
10
15
11
16
### Android
@@ -92,22 +97,22 @@ int main(int argc, char *argv[]) {
92
97
Use the following commands to download WasmEdge for Android on your Ubuntu dev machine.
0 commit comments