Skip to content

docs: fix SenseVoice README images and Android SDK guide link - #3775

Merged
LauraGPT merged 1 commit into
modelscope:mainfrom
pratikgx:docs-fix-sensevoice-images
Oct 16, 2026
Merged

LauraGPT merged 1 commit into
modelscope:mainfrom
pratikgx:docs-fix-sensevoice-images

Conversation

@pratikgx

Copy link
Copy Markdown
Contributor

Summary

The SenseVoice example READMEs (README.md, README_zh.md, README_ja.md in examples/industrial_data_pretraining/sense_voice/) were ported from the SenseVoice repository and still reference images as src="image/<name>.png". FunASR has no image/ folder there, so every figure (overview, ASR and SER results, AED figure, inference benchmark, WebUI, DingTalk QR) is broken on GitHub.

This points each image at the copy in the SenseVoice repository, https://raw.githubusercontent.com/QwenAudio/SenseVoice/main/image/<name>.png (the repository formerly at FunAudioLLM/SenseVoice, matching the header URL already used by the .py files in this folder).

It also fixes runtime/android/readme.md, whose link to SDK_advanced_guide_online_zh.md still uses the old funasr/runtime/docs/ path; the file is at runtime/docs/SDK_advanced_guide_online_zh.md.

Type of change

  • Bug fix
  • Documentation
  • Example or demo
  • Runtime or deployment
  • Benchmark or evaluation
  • Model/training change

Validation

Docs-only change, 27 lines across 4 files. Confirmed that all 10 referenced images (sensevoice2, sensevoice, asr_results1, asr_results2, ser_table, ser_figure, aed_figure, inference, webui, dingding_funasr) exist under image/ on the SenseVoice main branch, and that runtime/docs/SDK_advanced_guide_online_zh.md exists at main. Resolved every link in the changed files; all point to existing files. No code paths are touched, so compileall and runtime tests are not applicable.

  • python -m compileall funasr examples tests
  • Docs or links checked
  • Runtime/deployment command tested

User impact

Readers of the SenseVoice example docs (English, Chinese and Japanese) see the model overview, benchmark figures and WebUI screenshot instead of broken images, and Android client users reach the online SDK guide.

Notes for reviewers

Path-only change, no content edits. Two of the replaced references sit inside [//]: # comments and are not rendered; they were updated for consistency.

The SenseVoice example READMEs were ported from the SenseVoice repository and reference images under image/, which does not exist in FunASR. Point them at the images in QwenAudio/SenseVoice (formerly FunAudioLLM/SenseVoice). Also drop the stale funasr/ prefix from the SDK_advanced_guide_online_zh.md link in runtime/android/readme.md.

@LauraGPT LauraGPT left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validated exact head 87174cb against base 28a889c. All four files differ only by the intended link replacements; all 10 distinct SenseVoice targets returned valid PNG content, and the Android guide target exists at the corrected path. The exact-head browser, build-and-validate, legacy-docs-links, and checkpoint-selection checks are also successful. This is documentation-only validation; no model or runtime path changed.

@LauraGPT
LauraGPT merged commit dddd5dc into modelscope:main Oct 16, 2026
4 checks passed
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.

2 participants