Skip to content

Commit

Permalink
Updated Notes
Browse files Browse the repository at this point in the history
Signed-off-by: Adithya Krishna <[email protected]>
  • Loading branch information
adithyaakrishna committed Oct 16, 2023
1 parent e3b5c2b commit 617a9d9
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 8 deletions.
24 changes: 19 additions & 5 deletions docs/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest

When ready for review, push your branch to your fork repository on github.

Then visit your fork at <https://github.com/$user/WasmEdge> and click the `Compare & Pull Request` button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes.
Then visit your fork at <https://github.com/$user/WasmEdge> and click the `Compare & Pull Request` button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference issues (using keywords such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes.

Once your pull request has been opened, it will be assigned to one or more reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and coding style.

Expand All @@ -71,10 +71,24 @@ Because the issues are open to the public, when submitting the log and configura

## Documenting

Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.
Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. Our docs reside at this [repository](https://github.com/WasmEdge/docs/)

## Design new features
See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.

You can propose new designs for existing WasmEdge features. You can also design new features; please submit a proposal via the GitHub issues.
## Feature Requests

- **Suggesting Enhancements**: If you have ideas for improving existing features in WasmEdge, we welcome your input.
- **Introducing New Features**: You're also encouraged to propose completely new functionalities that could benefit the project.
- **How to Submit**: To formalize your suggestions, please submit a feature request proposal through [GitHub Issues](https://github.com/WasmEdge/docs/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.yml&title=Feature+Request%3A+).

### Review Process

- **Timely Evaluation**: Our team of WasmEdge maintainers will review your proposal as quickly as possible.
- **Architectural Consistency**: We aim to ensure that all contributions align well with the existing architecture of WasmEdge.
- **Avoiding Redundancy**: Part of the review process includes checking the project's roadmap to avoid duplicated efforts.

### Communication

- **Feedback Loop**: After the initial review, we may ask for further clarifications or suggest modifications to align with the project's goals.
- **Status Updates**: We aim to keep you informed about the status of your proposal throughout the review process.

WasmEdge maintainers will review this proposal as soon as possible to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap.
5 changes: 4 additions & 1 deletion docs/embed/go/reference/0.9.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,10 @@ Run bindgen -- keccak_digest: [126 194 241 200 151 116 227 33 216 99 159 22 107
### Example of Embedding A Full WASI Program
Note: You can use the latest Rust compiler to create a standalone WasmEdge application with a `main.rs` functions and then embed it into a Golang application.
<!-- prettier-ignore -->
:::note
You can use the latest Rust compiler to create a standalone WasmEdge application with a `main.rs` functions and then embed it into a Golang application.
:::
Besides functions, the WasmEdge Golang SDK can also [embed standalone WebAssembly applications](https://github.com/second-state/WasmEdge-go-examples/tree/master/go_ReadFile) — i.e. a Rust application with a `main()` function compiled into WebAssembly.
Expand Down
7 changes: 6 additions & 1 deletion docs/start/usage/serverless/vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,12 @@ That's it. [Deploy the repo to Vercel](https://vercel.com/docs/git#deploying-a-g

The [second demo](https://vercel-wasm-runtime.vercel.app/) application allows users to upload an image and then invoke a serverless function to classify the main subject on the image.

It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch. Note: when you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch.

<!-- prettier-ignore -->
:::note
When you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
:::

The backend serverless function for image classification is in the [`api/functions/image-classification`](https://github.com/second-state/vercel-wasm-runtime/tree/tensorflow/api/functions/image-classification) folder in the `tensorflow` branch. The [`src/main.rs`](https://github.com/second-state/vercel-wasm-runtime/blob/tensorflow/api/functions/image-classification/src/main.rs) file contains the Rust program’s source code. The Rust program reads image data from the `STDIN`, and then outputs the text output to the `STDOUT`. It utilizes the WasmEdge Tensorflow API to run the AI inference.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,12 @@ That's it. [Deploy the repo to Vercel](https://vercel.com/docs/git#deploying-a-g

The [second demo](https://vercel-wasm-runtime.vercel.app/) application allows users to upload an image and then invoke a serverless function to classify the main subject on the image.

It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch. Note: when you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch.

<!-- prettier-ignore -->
:::note
When you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
:::

The backend serverless function for image classification is in the [`api/functions/image-classification`](https://github.com/second-state/vercel-wasm-runtime/tree/tensorflow/api/functions/image-classification) folder in the `tensorflow` branch. The [`src/main.rs`](https://github.com/second-state/vercel-wasm-runtime/blob/tensorflow/api/functions/image-classification/src/main.rs) file contains the Rust program’s source code. The Rust program reads image data from the `STDIN`, and then outputs the text output to the `STDOUT`. It utilizes the WasmEdge Tensorflow API to run the AI inference.

Expand Down

0 comments on commit 617a9d9

Please sign in to comment.