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

add zh-cn translation #185

Merged
merged 25 commits into from
Jan 25, 2024
Merged

add zh-cn translation #185

merged 25 commits into from
Jan 25, 2024

Conversation

ezirmusitua
Copy link
Contributor

Explanation

Add zh-cn translation

Related issue

N/A

What type of PR is this

/kind documentation

Proposed Changes

Translate i18n/zh/docusaurus-plugin-content-docs/current/

Copy link
Collaborator

alabulei1 commented Oct 31, 2023

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


Summary:

After reviewing all the individual summaries, the overall summary of the GitHub Pull Request titled "add zh-cn translation" is as follows:

The pull request includes several translations from English to Simplified Chinese across different files in the documentation. While most of the changes seem correct and valuable, there are a few potential problems and errors that need to be addressed.

Potential problems include a large number of file changes, lack of context or explanation for the changes, accuracy and consistency of translations, lack of tests for translated content, lack of review by a native Chinese speaker, inclusion of personal information in the patch, broken hyperlinks, duplication of sections, formatting issues, lack of context for changes to commands and sample prompts, and potential issues with the removal of the step to download the model file.

The most important findings include accurate and comprehensive translation for the new file llm_inference.md and improvement of the installation instructions with Chinese translation. However, it's crucial to address the potential problems and make necessary improvements before merging the pull request.

Details

Commit 8c68af5f0241b4aa590de9966262d52e38ef287a

Key Changes:

  • Translated the document from English to Simplified Chinese (zh-cn).
  • Replaced the English text with its corresponding Chinese translation.

Potential Problems:

  • No potential problems were identified.

Overall, this pull request seems to be a straightforward translation from English to Simplified Chinese. The changes look correct and there are no obvious issues.

Commit 8fd09b10657f8586317f799fed94f896b4ab29b1

Key changes:

  • Added translation for various files in the start/build-and-run directory, including _category_.json, aot.md, cli.md, docker_wasm.md, and run.md.
  • Added translation for various files in the start/getting-started directory, including _category_.json, quick_start.md, quick_start_docker.md, and quick_start_redhat.md.
  • Added translation for various files in the start/usage/serverless directory, including _category_.json, aws.md, netlify.md, tencent.md, and vercel.md.
  • Added translation for various files in the start/usage directory, including _category_.json, use-cases.md, and wasm-smart-devices.md.
  • Added translation for various files in the start/wasmedge directory, including _category_.json, comparison.md, component_model.md, extensions/_category_.json, extensions/plugins.md, extensions/proposals.md, extensions/unique_extensions.md, features.md, and integrations.md.

Potential problems:

  • The patch includes a large number of file changes, which may make it difficult to review the changes comprehensively.
  • It is not clear why these specific files were chosen for translation and if any other files need to be updated as well.
  • It would be helpful to have more context or explanation behind the changes made in each file.
  • It is important to ensure the accuracy and consistency of the translations.

Commit fca42f5ae0f026ab5f29c926619c77e0b265492b

Key changes:

  • The patch updates the links to the scripts in the Chinese translation of the documentation.
  • The patch also updates some of the text in the documentation to improve readability and accuracy.

Potential problems:

  • The patch is relatively small and mainly consists of link updates and text changes, so there are no major potential problems identified.
  • However, it's worth noting that the changes made to the text should be reviewed by someone who is proficient in Chinese to ensure accuracy and clarity.
  • It's also important to ensure that the updated links are pointing to the correct resources and that the URLs are valid.

Overall, the changes in this patch seem minor and should not introduce any major issues.

Commit 9ee9f25ce09f61563b03c2d3115fd21667f012e5

Key Changes:

  • Added a new file llm_inference.md under the docs/develop/rust/wasinn directory.
  • Added Chinese translation for the content of llm_inference.md.
  • Added Chinese translation for a few lines in the existing mediapipe.md file.
  • Added a list of files with relevant changes.

Findings:

  • The pull request adds Chinese translation for the content of llm_inference.md, which is a new file. This allows Chinese users to understand and use the Llama 2 inference feature in Rust.
  • The translation appears to be accurate and includes all the necessary details, including prerequisites, quick start instructions, build and run steps, optional configurations, improving performance, and understanding the code.
  • The changes seem to be consistent with the existing documentation structure and format.
  • The patch also updates the mediapipe.md file with Chinese translation for a few lines. Although the changes are minimal, they contribute to making the documentation consistent.
  • Overall, the changes are valuable for the Chinese-speaking community.

Potential Problems:

  • The patch does not include any tests or test coverage for the translated content. It's recommended to add tests to ensure the accuracy and validity of the translation.
  • It's unclear if the translation has been reviewed by a native Chinese speaker to ensure the quality and correctness of the translated content.
  • The contributor's email address and personal information are included in the patch. It's advisable to remove personal information from the patch before merging it.

Suggestions:

  • Add tests for the translated content to ensure its accuracy.
  • Consider having the translation reviewed by a native Chinese speaker for quality assurance.
  • Remove personal information from the patch before merging it.
  • Once the above suggestions are addressed, the patch can be merged.

Commit c2110dc6a58e0e0be6270f3fce95306ffc24e02d

Key changes:

  • Updated the installation instructions for several backend plugins in the English documentation.
  • Added Chinese translation for the installation instructions in the Chinese documentation.

Potential problems:

  1. In the English documentation, there is a broken hyperlink in the line that says "Then, go to the Llama2 inference in Rust chapter..." The correct link should be llm-inference instead of llm_inference.
  2. In the Chinese documentation, there is a duplication of the section titled "带有 PyTorch 后端的 WASI-NN 插件". It appears twice with the same content. One of the sections should be removed.
  3. There is a formatting issue in the Chinese translation of the section titled "带有 ggml 后端的 WASI-NN 插件". The symbol ">" is missing at the beginning of the line that says "注意,WasmEdge 0.13.5 的安装程序将自动检测 CUDA。"

Overall, the changes seem to be adding Chinese translation for the installation instructions in the Chinese documentation. There are a few minor issues that need to be addressed.

Commit 78dc85bf393b2caaa17530007d22841483791ff5

Key Changes:

  • Updated the command in the "Run the inference application in WasmEdge" section.
  • Added sample user prompts and assistant responses for better illustration.
  • Added optional CLI options for more information.

Potential Problems:

  • It seems that the patch introduces changes to improve the command and add sample prompts, which should not introduce any issues.
  • However, it would be helpful to provide more context or explanations for the changes, especially the addition of the sample prompts.

Commit 1843de186478e25679714d43fc4f889972e34848

Key changes:

  • Added Chinese translation to the llm_inference.md file.
  • Modified the command examples to include the Chinese translation.

Potential problems:

  • There are no potential problems identified in this patch.

Overall, the patch seems to be a straightforward addition of a Chinese translation to the llm_inference.md file.

Commit 3b682dfc647622b3c4df2faa782f576bf68a3771

Key changes:

  • The patch updates the URL used to download the model file llama-2-13b-q5_k_m.gguf to llama-2-13b-chat-q5_k_m.gguf.

Potential problems:

  • There doesn't seem to be any problem with the changes made in this patch. It appears to be a simple update to the model file URL.

Commit f8e72fe494022230f2b1f23fba57db20ab246dd2

Key Changes:

  • Updated the command to use the llama-2-7b model instead of llama-2-13b.
  • Removed the step to download the model file.
  • Aligned the wasmedge command for loading the model and asking questions with the updated model file name.
  • Updated the command for AOT compiling the wasm file.

Potential Problems:

  • The patch removes the step to download the model file, assuming it is already available. This may cause issues if the model file is not present.
  • The patch updates the model file name and the wasmedge command for loading the model and asking questions, but it is not clear if the model file was actually renamed or if there was a mistake in the patch.
  • The patch does not account for potential errors or exceptions that may occur during the execution of the commands. Error handling should be added to provide better resilience.
  • The patch contains a typo in the code comment at the end, where "finished" is misspelled as "fiished".

Commit 2873e6d1c5983ed5ecd09b910fb670cbd09835b4

Key changes:

  • Added the Chinese translation for the "overview.md" file in the "start" directory.
  • Added a heading "开始使用 WasmEdge" (Start using WasmEdge) at the beginning of the file.
  • Added content and links related to getting started with WasmEdge in Chinese.
  • Added content and links related to advanced programming with WasmEdge in Chinese.
  • Added contact information in Chinese.

Potential problems:

  • No potential problems identified. The changes seem to be straightforward translations of the existing English content into Chinese.

Commit dc44b1134777c560c73ce13101ab2a68448cda92

Key changes in the patch:

  • Added missing links to the table in the plugins.md file.
  • Updated the links for the WasmEdge-Process, WASI-NN, WasmEdge-Image, and WasmEdge-Tensorflow entries.

Potential problems:

  • The links for the WASI-NN entries have incorrect markdown formatting. The parentheses around the backend names should be enclosed in square brackets.

Commit 62661bd59a1ac09770d6050020d98fcac2937759

Key changes:

  • Fixed links in the plugins.md file in the zh translation.

Potential problems:

  • There doesn't appear to be any potential problems in this patch. The changes are straightforward and seem to address the issue of broken links in the translation.

Commit d1195b0277ba16220341adec9cb7e022ee6a6d6d

Key Changes:

  • Added missing links to the document for Chinese (zh-cn) translation.

Potential Problems:

  • There doesn't appear to be any potential problems with this patch. The changes seem to be straightforward and correctly formatted.

Overall, the patch successfully adds the missing links to the translated document. The changes look good and can be merged into the codebase.

Commit c3d03789f7d31c1a5f636534d58bf2e5dc1aa587

Key changes in the patch:

  • Remove unnecessary space in several Markdown files.
  • Correct some links and text formatting.

Potential problems:

  • No potential problems found in this patch.

Commit 18acb3ea4d63a40cdded9fcba2365cd4162e898b

Key changes:

  • The patch updates two files: aws.md and vercel.md in the start/usage/serverless folder.
  • In both files, the phrase "将构建结果复制到 api 文件夹。" has been translated to "将构建产物复制到 api 文件夹。"

Potential problems:

  • There are no obvious problems with this patch. The changes appear to be a straightforward translation.

Overall, this patch seems to be a simple translation update without any significant issues.

Commit ad7597a39880879de04bb178adc909e34bc1a39b

Key changes:

  • The Chinese translation has been added to the following files: aws.md, netlify.md, and vercel.md.
  • The changes include modifying the wording and adjusting the formatting of the translated text.

Potential problems:

  • There are no potential problems identified in this patch.
  • The changes seem to be correct and in line with the existing content.

Overall, the patch adds the Chinese translation to the specified files without any apparent issues.

Commit 07fbf851a8899beb0c1986883d494cdd789b516b

Key changes:

  • The patch removes the line "# 开始使用 WasmEdge" from the file i18n/zh/docusaurus-plugin-content-docs/current/start/overview.md.

Potential problems:

  • It is not clear why the line was removed. The patch does not provide any explanation or rationale for this change.
  • It is important to ensure that the translation is accurate and consistent with the overall content. Without knowing the context and purpose of the line, it is difficult to assess the impact of its removal on the translated document.
  • It is generally advisable to include a commit message or pull request comment explaining the changes made in the patch for better understanding and collaboration with other contributors.
  • It is also recommended to follow a consistent style and formatting in the file, especially in terms of headings and content structure.

Overall, more information and context are needed to fully assess the impact and quality of this patch.

Commit 2ce027abe2574d9be70998fbd448f20d8a29ea94

Key changes:

  • Translation of text descriptions from English to Chinese (Simplified)

Potential problems:

  • No potential problems found.

Overall, this patch seems to be a straightforward translation of the content from English to Chinese (Simplified). No potential problems were identified.

Commit 03ee4f694b87ad8d72428de780d154fb6c55c6b8

Key changes:

  • The patch updates two files in the i18n/zh folder, specifically in the docusaurus-plugin-content-docs/current/start/usage/serverless subdirectory.
  • In both files, the phrase "将构建出结果复制到 api 文件夹。" is changed to "将构建产物复制到 api 文件夹中。".

Potential problems:

  • There don't seem to be any potential problems with these changes.

Commit fed1f5552173614ac81ee7a2bd0617283eacebb8

Key Changes:

  • Updated the translation for the Chinese version of the CLI page.
  • Updated the translation for the Chinese version of the Quick Start page.
  • Updated the translation for the Chinese version of the Quick Start Docker page.

Potential Problems:

  • No potential problems were identified in this patch.

Overall, the changes seem to be straightforward translation updates for the Chinese version of the documentation.

Commit a1af96ba8e4c9cfbdfe6dec348ba2a060ba3cc5d

Key changes:

  • The title of the document has been changed from "Red Hat 快速入门" to "在 Red Hat 下的快速入门".

Potential problems:

  • None identified.

Commit 39c77446c17f125780da50e0cd7d21068c807936

Key changes:

  • The patch fixes translations in several files related to WasmEdge extensions and plugins.

Potential problems:

  • There seem to be no potential problems in this patch. It only contains translation fixes, which should not introduce any issues.

Commit 80f89dd108882deb5e546f240c5ea25a1f0834f4

Key changes:

  • Fixed a rebase issue.

Potential problems:

  • No potential problems identified.

@alabulei1
Copy link
Collaborator

Hi @ezirmusitua

Thanks for your contribution. You really did a lot of work. It will take me some time to review your PR. Thank you very much!

@alabulei1
Copy link
Collaborator

@ezirmusitua Please fix the DCO problem.

ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 15, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 15, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 15, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 15, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 15, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
ezirmusitua referenced this pull request in ezirmusitua/WasmEdge_docs Nov 19, 2023
juntao and others added 16 commits November 20, 2023 09:01
Signed-off-by: Michael Yuan <[email protected]>
Signed-off-by: Michael Yuan <[email protected]>
…ew.md (WasmEdge#183)

* translate i18n/zh/docusaurus-plugin-content-docs/current/start/ overview.md

Signed-off-by: ezirmusitua <[email protected]>

* Update overview.md

Signed-off-by: ezirmusitua <[email protected]>

---------

Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: ezirmusitua <[email protected]>
@alabulei1 alabulei1 merged commit fc4aaab into WasmEdge:main Jan 25, 2024
6 checks passed
@alabulei1
Copy link
Collaborator

Hi @ezirmusitua

Sorry for my late reply. Thank you!

kelvinparmar pushed a commit to kelvinparmar/docs that referenced this pull request Feb 3, 2024
* translate i18n/zh/docusaurus-plugin-content-docs/current/start/ overview.md

Signed-off-by: ezirmusitua <[email protected]>

* add zh-cn translation

Signed-off-by: ezirmusitua <[email protected]>

* fix: repo references

Signed-off-by: ezirmusitua <[email protected]>

* Signed-off-by: alabulei1 <[email protected]>

* Update llm inference docs (WasmEdge#187)

Signed-off-by: alabulei1 <[email protected]>

* Update llm_inference.md

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

* Update llm_inference.md

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

* Update llm_inference.md

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

* Update llm_inference.md

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

* translate i18n/zh/docusaurus-plugin-content-docs/current/start/overview.md (WasmEdge#183)

* translate i18n/zh/docusaurus-plugin-content-docs/current/start/ overview.md

Signed-off-by: ezirmusitua <[email protected]>

* Update overview.md

Signed-off-by: ezirmusitua <[email protected]>

---------

Signed-off-by: ezirmusitua <[email protected]>

* add missing links

Signed-off-by: ezirmusitua <[email protected]>

* fix links in plugins(zh)

Signed-off-by: ezirmusitua <[email protected]>

* add missing links

Signed-off-by: ezirmusitua <[email protected]>

* doc: remove unnecessary space

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392653345

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392652961

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392647856

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392604553

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392650533

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392621661

Signed-off-by: ezirmusitua <[email protected]>

* apply suggestion https://github.com/WasmEdge/docs/pull/185\#discussion_r1392632935

Signed-off-by: ezirmusitua <[email protected]>

* fix translations

Signed-off-by: ezirmusitua <[email protected]>

* fix rebase

Signed-off-by: ezirmusitua <[email protected]>

---------

Signed-off-by: ezirmusitua <[email protected]>
Signed-off-by: alabulei1 <[email protected]>
Signed-off-by: Michael Yuan <[email protected]>
Signed-off-by: Michael Yuan <[email protected]>
Co-authored-by: alabulei1 <[email protected]>
Co-authored-by: Michael Yuan <[email protected]>
Signed-off-by: kelvin <[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.

4 participants