mirror of
https://github.com/modelscope/FunASR.git
synced 2026-10-12 02:19:18 +00:00
docs: add community growth and contribution guides
Merge pull request #2863 from codex/growth-20k
This commit is contained in:
zhifu gao
@@ -1,38 +1,41 @@
|
||||
---
|
||||
name: ❓ Questions/Help
|
||||
about: If you have questions, please first search existing issues and docs
|
||||
about: Ask for help after checking existing issues and docs
|
||||
labels: 'question, needs triage'
|
||||
---
|
||||
|
||||
Notice: In order to resolve issues more efficiently, please raise issue following the template.
|
||||
（注意：为了更加高效率解决您遇到的问题，请按照模板提问，补充细节）
|
||||
Notice: In order to resolve issues efficiently, please follow the template.
|
||||
（注意：为了更加高效率解决您遇到的问题，请按照模板提问，补充细节。）
|
||||
|
||||
## ❓ Questions and Help
|
||||
## Before asking
|
||||
|
||||
1. Search existing issues: https://github.com/modelscope/FunASR/issues
|
||||
2. Search the docs: https://modelscope.github.io/FunASR/
|
||||
3. Check the README quick start and deployment section.
|
||||
|
||||
### Before asking:
|
||||
1. search the issues.
|
||||
2. search the docs.
|
||||
## Question
|
||||
|
||||
<!-- If you still can't find what you need: -->
|
||||
<!-- What are you trying to do, and where are you blocked? -->
|
||||
|
||||
#### What is your question?
|
||||
## Code or command
|
||||
|
||||
#### Code
|
||||
```bash
|
||||
|
||||
<!-- Please paste a code snippet if your question requires it! -->
|
||||
```
|
||||
|
||||
#### What have you tried?
|
||||
## What have you tried?
|
||||
|
||||
#### What's your environment?
|
||||
<!-- Include links to docs or examples you followed, plus the exact error/result. -->
|
||||
|
||||
- OS (e.g., Linux):
|
||||
- FunASR Version (e.g., 1.0.0):
|
||||
- ModelScope Version (e.g., 1.11.0):
|
||||
- PyTorch Version (e.g., 2.0.0):
|
||||
- How you installed funasr (`pip`, source):
|
||||
- Python version:
|
||||
- GPU (e.g., V100M32)
|
||||
- CUDA/cuDNN version (e.g., cuda11.7):
|
||||
- Docker version (e.g., funasr-runtime-sdk-cpu-0.4.1)
|
||||
- Any other relevant information:
|
||||
## Environment
|
||||
|
||||
- OS:
|
||||
- Python version:
|
||||
- FunASR version:
|
||||
- ModelScope version:
|
||||
- PyTorch / torchaudio version:
|
||||
- Install method (`pip`, source, Docker):
|
||||
- Device (`cuda`, `cpu`, `mps`):
|
||||
- GPU model:
|
||||
- CUDA/cuDNN version:
|
||||
- Docker image tag, if used:
|
||||
|
||||
@@ -1,47 +1,64 @@
|
||||
---
|
||||
name: 🐛 Bug Report
|
||||
about: Submit a bug report to help us improve
|
||||
about: Submit a reproducible bug report to help us improve FunASR
|
||||
labels: 'bug, needs triage'
|
||||
---
|
||||
|
||||
Notice: In order to resolve issues more efficiently, please raise issue following the template.
|
||||
（注意：为了更加高效率解决您遇到的问题，请按照模板提问，补充细节）
|
||||
Notice: In order to resolve issues efficiently, please follow the template and include reproducible details.
|
||||
（注意：为了更加高效率解决您遇到的问题，请按照模板提问，补充可复现细节。）
|
||||
|
||||
## 🐛 Bug
|
||||
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
<!-- A clear and concise description of the bug. -->
|
||||
|
||||
### To Reproduce
|
||||
## To Reproduce
|
||||
|
||||
Steps to reproduce the behavior (**always include the command you ran**):
|
||||
Steps to reproduce the behavior. Always include the exact command you ran.
|
||||
|
||||
1. Run cmd '....'
|
||||
2. See error
|
||||
1. Install with: `...`
|
||||
2. Run: `...`
|
||||
3. See error: `...`
|
||||
|
||||
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
|
||||
## Code sample
|
||||
|
||||
<!-- Paste the smallest code sample that still reproduces the issue. -->
|
||||
|
||||
#### Code sample
|
||||
<!-- Ideally attach a minimal code sample to reproduce the decried issue.
|
||||
Minimal means having the shortest code but still preserving the bug. -->
|
||||
```python
|
||||
|
||||
### Expected behavior
|
||||
```
|
||||
|
||||
## Expected behavior
|
||||
|
||||
<!-- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
### Environment
|
||||
## Error logs
|
||||
|
||||
- OS (e.g., Linux):
|
||||
- FunASR Version (e.g., 1.0.0):
|
||||
- ModelScope Version (e.g., 1.11.0):
|
||||
- PyTorch Version (e.g., 2.0.0):
|
||||
- How you installed funasr (`pip`, source):
|
||||
- Python version:
|
||||
- GPU (e.g., V100M32)
|
||||
- CUDA/cuDNN version (e.g., cuda11.7):
|
||||
- Docker version (e.g., funasr-runtime-sdk-cpu-0.4.1)
|
||||
- Any other relevant information:
|
||||
<!-- Paste the full traceback or relevant logs. Remove private tokens and paths. -->
|
||||
|
||||
### Additional context
|
||||
```text
|
||||
|
||||
<!-- Add any other context about the problem here. -->
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
- OS:
|
||||
- Python version:
|
||||
- FunASR version:
|
||||
- ModelScope version:
|
||||
- PyTorch / torchaudio version:
|
||||
- Install method (`pip`, source, Docker):
|
||||
- Device (`cuda`, `cpu`, `mps`):
|
||||
- GPU model:
|
||||
- CUDA/cuDNN version:
|
||||
- Docker image tag, if used:
|
||||
|
||||
## Audio details
|
||||
|
||||
If the audio cannot be shared, please describe:
|
||||
|
||||
- Duration:
|
||||
- Sample rate:
|
||||
- Format:
|
||||
- Language/dialect:
|
||||
- Speaker count:
|
||||
- Background noise/music:
|
||||
|
||||
@@ -1 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: FunASR documentation
|
||||
url: https://modelscope.github.io/FunASR/
|
||||
about: Read installation, tutorial, deployment, benchmark, and API docs.
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/modelscope/FunASR/discussions
|
||||
about: Share ideas, showcase usage, and ask open-ended community questions.
|
||||
- name: Hugging Face models
|
||||
url: https://huggingface.co/funasr
|
||||
about: Browse FunASR checkpoints on Hugging Face.
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: 🚀 Deployment Help
|
||||
about: Get help with API server, WebSocket, Docker, vLLM, Triton, Android, or agent integration
|
||||
labels: 'deployment, needs triage'
|
||||
---
|
||||
|
||||
## Deployment target
|
||||
|
||||
- [ ] OpenAI-compatible API server
|
||||
- [ ] WebSocket streaming service
|
||||
- [ ] Docker runtime
|
||||
- [ ] vLLM acceleration
|
||||
- [ ] Triton
|
||||
- [ ] Android / mobile
|
||||
- [ ] Browser / Web UI
|
||||
- [ ] MCP / agent integration
|
||||
- [ ] Other:
|
||||
|
||||
## Goal
|
||||
|
||||
<!-- What user-facing service or workflow are you trying to deploy? -->
|
||||
|
||||
## Command or config
|
||||
|
||||
```bash
|
||||
|
||||
```
|
||||
|
||||
## Error or unexpected behavior
|
||||
|
||||
```text
|
||||
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
- OS:
|
||||
- Python version:
|
||||
- FunASR version:
|
||||
- Install method (`pip`, source, Docker):
|
||||
- Device (`cuda`, `cpu`, `mps`):
|
||||
- GPU model and memory:
|
||||
- CUDA/cuDNN version:
|
||||
- Docker image tag, if used:
|
||||
- Network endpoint / port:
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
name: ✨ Feature Request
|
||||
about: Suggest a model, language, runtime, deployment, benchmark, or documentation improvement
|
||||
labels: 'enhancement, needs triage'
|
||||
---
|
||||
|
||||
## Use case
|
||||
|
||||
<!-- What are you trying to build, deploy, evaluate, or research with FunASR? -->
|
||||
|
||||
## Proposed solution
|
||||
|
||||
<!-- Describe the desired model/API/runtime/doc/benchmark behavior. -->
|
||||
|
||||
## Alternatives or workarounds
|
||||
|
||||
<!-- What workaround are you using today? What other tools did you consider? -->
|
||||
|
||||
## Expected impact
|
||||
|
||||
<!-- Who benefits: new users, production deployers, researchers, agent builders, educators, etc.? -->
|
||||
|
||||
## Willing to contribute?
|
||||
|
||||
- [ ] I can submit a PR
|
||||
- [ ] I can help test
|
||||
- [ ] I can provide data, logs, or benchmark results
|
||||
@@ -0,0 +1,28 @@
|
||||
## Summary
|
||||
|
||||
<!-- What changed and why? -->
|
||||
|
||||
## Type of change
|
||||
|
||||
- [ ] Bug fix
|
||||
- [ ] Documentation
|
||||
- [ ] Example or demo
|
||||
- [ ] Runtime or deployment
|
||||
- [ ] Benchmark or evaluation
|
||||
- [ ] Model/training change
|
||||
|
||||
## Validation
|
||||
|
||||
<!-- Commands run, logs, screenshots, benchmark results, or why validation is not applicable. -->
|
||||
|
||||
- [ ] `python -m compileall funasr examples tests`
|
||||
- [ ] Docs or links checked
|
||||
- [ ] Runtime/deployment command tested
|
||||
|
||||
## User impact
|
||||
|
||||
<!-- Who benefits from this change? New users, production deployers, researchers, agent builders, etc. -->
|
||||
|
||||
## Notes for reviewers
|
||||
|
||||
<!-- Compatibility notes, risks, follow-up work, or review focus. -->
|
||||
Reference in New Issue
Block a user