Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install instructions #194

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Update install instructions #194

merged 2 commits into from
Nov 14, 2023

Conversation

juntao
Copy link
Member

@juntao juntao commented Nov 14, 2023

Explanation

Improve the installation instructions, especially around plugins.

Signed-off-by: Michael Yuan <[email protected]>
Copy link
Collaborator

alabulei1 commented Nov 14, 2023

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Overall Summary:

In reviewing the GitHub Pull Request titled "Update install instructions", a number of potential issues and errors have been identified. These issues include referencing specific versions of plug-ins and backends, lack of details on how to use the wasmedge_rustls plug-in, missing installation instructions for dependencies of PyTorch and OpenVINO backends, outdated or non-existent documentation references, and lack of information on conflicts or compatibility issues between plug-ins and backends.

Among the key changes introduced in the patch are updates to the installation commands for various plug-ins, clarifications of the TF Lite plugin status, and instructions for installing dependencies for TF and TF Lite plugins.

The most important findings prioritize the need for general instructions or latest version references instead of specific versions, providing details and examples of how to use the wasmedge_rustls plug-in, including installation instructions for PyTorch and OpenVINO dependencies, reviewing and updating documentation references, addressing potential conflicts or compatibility issues, explaining the deprecation of the TF Lite plugin, and adding uninstallation instructions for the TF Lite plugin. Additionally, the consolidation of duplicate sections for installing dependencies would enhance the readability and clarity of the instructions.

Details

Commit 99777e76a049225f34e96a3e88c0a17f05fd400a

Key changes in the patch:

  • Updated the command to install the wasmedge_rustls plug-in instead of the wasi_nn-tensorflowlite plug-in.
  • Updated the example command for installing multiple plug-ins to include the wasmedge_rustls and wasi_nn-ggml plug-ins.
  • Added an alternative installation command for the WasmEdge TLS plug-in using the updated installer script.
  • Updated the instructions for installing the WASI-NN plug-ins with the correct command for each backend (ggml, PyTorch, OpenVINO).

Potential problems in the patch:

  • In multiple places, the patch references specific versions of plug-ins and backends, such as 0.13.4 and 1.8.2. These versions may become outdated over time, so it would be better to use general instructions or references to the latest versions.
  • The patch mentions that the wasmedge_rustls plug-in enables TLS and HTTPS networking, but it does not provide any details or examples of how to actually use it.
  • The patch mentions dependencies for the PyTorch and OpenVINO backends, but it does not provide instructions on how to install those dependencies.
  • The patch refers to chapters or sections in the documentation that may not exist or may have been moved or renamed, which could cause confusion for users trying to find related information.
  • The patch does not include any information about potential conflicts or compatibility issues between different plug-ins and backends. It would be helpful to address these potential problems or provide recommendations for handling them.

Commit 495d22d6a7245b6f7d14f37a6d8bcfbe7bb34157

Key changes in the patch:

  • Clarifies the status of the TF Lite plugin
  • Updates the installation instructions for the TF Lite plugin
  • Provides instructions for installing dependencies for both the TF and TF Lite plugins

Potential problems:

  • The patch does not mention why the TF Lite plugin is being deprecated. It would be helpful to include a brief explanation for users.
  • The patch does not provide instructions for uninstalling the TF Lite plugin if it was previously installed. Including uninstallation instructions would be useful for users who want to switch to the recommended WASI NN TensorflowLite plugin.
  • The patch includes duplicate sections for installing dependencies for TensorFlow and TensorFlow Lite plugins. These sections should be consolidated to improve readability and avoid redundancy.

@juntao juntao requested a review from hydai November 14, 2023 03:31
@hydai hydai merged commit 80f56b8 into main Nov 14, 2023
6 checks passed
@hydai hydai deleted the update-install branch November 14, 2023 03:47
dhruvmehtaaa pushed a commit to dhruvmehtaaa/docs that referenced this pull request Nov 14, 2023
* Update install instructions

Signed-off-by: Michael Yuan <[email protected]>

* Clarify the TF Lite plugin status

Signed-off-by: Michael Yuan <[email protected]>

---------

Signed-off-by: Michael Yuan <[email protected]>
Signed-off-by: dhruvmehtaaa <[email protected]>
dhruvmehtaaa pushed a commit to dhruvmehtaaa/docs that referenced this pull request Nov 14, 2023
* Update install instructions

Signed-off-by: Michael Yuan <[email protected]>

* Clarify the TF Lite plugin status

Signed-off-by: Michael Yuan <[email protected]>

---------

Signed-off-by: Michael Yuan <[email protected]>
Signed-off-by: dhruvmehtaaa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants