Conversation
Signed-off-by: LauraGPT <18321252+LauraGPT@users.noreply.github.com>
Signed-off-by: LauraGPT <18321252+LauraGPT@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Correct newcomer-facing problems in
CONTRIBUTING.md:python -m pipfor the selected environment and include the missingAutoModelimport in the CPU example.fastapi[standard]CLI dependencies before the documentedfastapi runcommand.User impact
Contributors should not start from a Python version that cannot resolve the repository requirements, encounter an undefined
AutoModelwhen copying the CPU snippet, or mistake research-family language coverage for the released checkpoint's supported languages.The separate cold install also reproduced
fastapi --helpexiting with code 1 because the base FastAPI package does not install its optional CLI. The server instructions now include the prerequisite reported by FastAPI itself.Model, API, and runtime impact
Validation
uv pip install --dry-run --python <environment>/bin/python --default-index https://pypi.org/simple -r requirements.txtagainst unchanged repository requirements.cp38wheel.python -m pip install --index-url https://pypi.org/simple -r requirements.txtcompleted against unchanged requirements (126 packages, 196 seconds).python -m pip check: no broken requirements. The guide'spython -c "from funasr import AutoModel; print('Installation successful')"completed successfully.fastapi --helpfailing with the missingfastapi[standard]prerequisite in the clean requirements-only environment; installing that extra completed successfully (103 seconds).Requires-Python: >=3.10.SenseVoiceSmall.lid_dictinmodel.pyagainst the documented language list.a73e0f6,python -m pytest -q tests/test_whats_new.py tests/test_canonical_qwenaudio_links.py tests/test_github_templates.py tests/test_funasr_requirement.py: 11 passed.a73e0f6,python3 -m unittest tests.test_container_contract tests.test_device_env: 14 passed.a73e0f6, parsed the Markdown with markdown-it-py, parsed/compiled the Python fence, checked itsfrom funasr import AutoModel, and checked removal of the obsolete prerequisite and checkpoint claim.git diff --check.db9d5ec6ff562dcd6062af38f7191d52e18802b4. Its execution log confirms 14 container/device tests and 6 model-timestamp tests passed; Docker context checks and the Linux AMD64 image build also passed. The pull-request workflow did not publish an image. This CI scope does not include the timed-out local documentation-test rerun or CLI/audio-load acceptance checks above.Notes for reviewers
Self-reviewed, signed and DCO-signed-off commit. A full dependency installation and import smoke checks were subsequently completed as listed above; no model download, CPU/GPU model inference, service acceptance test, or desktop/browser execution was performed. Other Python versions and platforms are not claimed as a tested compatibility matrix. The Orca release-link update in #355 is separate; this branch starts from main and changes only the contribution guide. No user issue is closed by this PR.