Skip to content

Commit 7bc6d75

Browse files
[CI] Add issue and pull request template; [Fix][Doc] Fix nfs doc error. (#62) (#64)
* [CI] Add issue template * [CI] Add pr template * [Fix][Doc] Fix nfs doc error, close #57 Co-authored-by: harrisonyhq <harrisonyhq@gmail.com>
1 parent a7538ac commit 7bc6d75

File tree

13 files changed

+479
-1
lines changed

13 files changed

+479
-1
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: 📚 Documentation
2+
description: Report an issue related to unifiedcache official website
3+
title: "[Doc]: "
4+
labels: ["documentation"]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: 📚 The doc issue
10+
description: >
11+
A clear and concise description of what content in unifiedcache official website is an issue.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Suggest a potential alternative/fix
17+
description: >
18+
Tell us how we could improve the documentation in this regard.
19+
- type: markdown
20+
attributes:
21+
value: >
22+
Thanks for contributing 🎉!
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 📚 User Story
2+
description: Apply for an user story to be displayed on unifiedcache official website
3+
title: "[User Story]: "
4+
labels: ["user-story"]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: 📚 Title
10+
description: >
11+
A clear title about what your user story is about.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: About / Introduction
17+
description: >
18+
A brief introduction about the background of your use case, like your scenario, hardware size etc.
19+
- type: textarea
20+
attributes:
21+
label: Bussiness Challenges
22+
description: >
23+
Tell us how what kind of challenge you faced in this user story.
24+
- type: textarea
25+
attributes:
26+
label: Solving challenges with unifiedcache and benefits
27+
description: >
28+
Tell us how unifiedcache helped you overcome the challenges, including details like how you use it, what version you used, hardware info, etc. And what kind of benefit do you get from using unifiedcache
29+
- type: textarea
30+
attributes:
31+
label: Extra Info
32+
description: >
33+
Any extra infomation you want to include in this story
34+
- type: markdown
35+
attributes:
36+
value: >
37+
Thanks for contributing 🎉!
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 🛠️ Installation
2+
description: Report an issue here when you hit errors during installation.
3+
title: "[Installation]: "
4+
labels: ["installation"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: Your current environment
14+
description: |
15+
Please run the following and paste the output below.
16+
**TODO: Add script to our project to collect the unifiedcache runtime environment, this following example comes from vllm-ascend**
17+
```sh
18+
npu-smi info
19+
cat /usr/local/Ascend/ascend-toolkit/latest/"$(uname -i)"-linux/ascend_toolkit_install.info
20+
wget https://raw.githubusercontent.com/vllm-project/vllm/main/collect_env.py
21+
# For security purposes, please feel free to check the contents of collect_env.py before running it.
22+
python collect_env.py
23+
```
24+
It is suggested to download and execute the latest script, as vllm might frequently update the diagnosis information needed for accurately and quickly responding to issues.
25+
value: |
26+
```text
27+
The output of `python collect_env.py`
28+
```
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: How you are installing unifiedcache, also vllm and vllm-ascend.
34+
description: |
35+
Paste the full command you are trying to execute.
36+
value: |
37+
```sh
38+
pip install -vvv unifiedcache
39+
```
40+
- type: markdown
41+
attributes:
42+
value: >
43+
Thanks for contributing 🎉!
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: 💻 Usage
2+
description: Raise an issue here if you don't know how to use unifiedcache.
3+
title: "[Usage]: "
4+
labels: ["usage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: Your current environment
14+
description: |
15+
Please run the following and paste the output below.
16+
**TODO: Add script to our project to collect the unifiedcache runtime environment, this following example comes from vllm-ascend**
17+
```sh
18+
npu-smi info
19+
cat /usr/local/Ascend/ascend-toolkit/latest/"$(uname -i)"-linux/ascend_toolkit_install.info
20+
wget https://raw.githubusercontent.com/vllm-project/vllm/main/collect_env.py
21+
# For security purposes, please feel free to check the contents of collect_env.py before running it.
22+
python collect_env.py
23+
```
24+
It is suggested to download and execute the latest script, as vllm might frequently update the diagnosis information needed for accurately and quickly responding to issues.
25+
value: |
26+
```text
27+
The output of above commands
28+
```
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: How would you like to use unifiedcache.
34+
description: |
35+
A detailed description of how you want to use unifiedcache.
36+
value: |
37+
I want to run inference of a [specific model](put link here). I don't know how to integrate it with unified.
38+
- type: markdown
39+
attributes:
40+
value: >
41+
Thanks for contributing 🎉!
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 🐛 Bug report
2+
description: Raise an issue here if you find a bug.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: Your current environment
14+
description: |
15+
Please run the following and paste the output below.
16+
**TODO: Add script to our project to collect the unifiedcache runtime environment, this following example comes from vllm-ascend**
17+
```sh
18+
wget https://raw.githubusercontent.com/vllm-project/vllm-ascend/main/collect_env.py
19+
# For security purposes, please feel free to check the contents of collect_env.py before running it.
20+
python collect_env.py
21+
```
22+
It is suggested to download and execute the latest script, as vllm might frequently update the diagnosis information needed for accurately and quickly responding to issues.
23+
value: |
24+
<details>
25+
<summary>The output of `python collect_env.py`</summary>
26+
27+
```text
28+
Your output of above commands here
29+
```
30+
31+
</details>
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: 🐛 Describe the bug
37+
description: |
38+
Please provide a clear and concise description of what the bug is.
39+
40+
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc.
41+
42+
If the code is too long (hopefully, it isn't), feel free to put it in a public gist and link it in the issue: https://gist.github.com.
43+
44+
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
45+
46+
Please set the environment variable `export VLLM_LOGGING_LEVEL=DEBUG` to turn on more logging to help debugging potential issues.
47+
48+
If you experienced crashes or hangs, it would be helpful to run vllm with `export VLLM_TRACE_FUNCTION=1` . All the function calls in vllm will be recorded. Inspect these log files, and tell which function crashes or hangs.
49+
placeholder: |
50+
A clear and concise description of what the bug is.
51+
52+
```python
53+
# Sample code to reproduce the problem
54+
```
55+
56+
```
57+
The error message you got, with the full traceback.
58+
```
59+
validations:
60+
required: true
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🚀 Feature request
2+
description: Submit a proposal/request for a new unifiedcache feature
3+
title: "[Feature]: "
4+
labels: ["feature request"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: 🚀 The feature, motivation and pitch
14+
description: >
15+
A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Alternatives
21+
description: >
22+
A description of any alternative solutions or features you've considered, if any.
23+
- type: textarea
24+
attributes:
25+
label: Additional context
26+
description: >
27+
Add any other context or screenshots about the feature request.
28+
- type: markdown
29+
attributes:
30+
value: >
31+
Thanks for contributing 🎉!
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 🤗 Support request for new model supported from huggingface/modelscope/modelers on unifiedcache
2+
description: Submit a proposal/request for a new model from huggingface/modelscope/modelers on unifiedcache
3+
title: "[New Model]: "
4+
labels: ["new model"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
12+
#### We also highly recommend you read our official website first to know which model already supported.
13+
- type: textarea
14+
attributes:
15+
label: The model to consider.
16+
description: >
17+
A huggingface/modelscope/modelers url, pointing to the model, e.g. https://huggingface.co/openai-community/gpt2 .
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: The closest model unifiedcache already supports.
23+
description: >
24+
Here is the list of models already supported by unifiedcache in our official website . Which model is the most similar to the model you want to add support for?
25+
- type: textarea
26+
attributes:
27+
label: What's your difficulty of supporting the model you want?
28+
description: >
29+
For example, any new operators or new architecture?
30+
- type: markdown
31+
attributes:
32+
value: >
33+
Thanks for contributing 🎉!
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: ⚡ Discussion on the performance of unifiedcache
2+
description: Submit a proposal/discussion about the performance of unifiedcache
3+
title: "[Performance]: "
4+
labels: ["performance"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: Proposal to improve performance
14+
description: >
15+
How do you plan to improve unifiedcache's performance?
16+
validations:
17+
required: false
18+
- type: textarea
19+
attributes:
20+
label: Report of performance regression
21+
description: >
22+
Please provide detailed description of performance comparison to confirm the regression. You may want to run the benchmark script at ...**TODO: specify our own benchmark method***.
23+
validations:
24+
required: false
25+
- type: textarea
26+
attributes:
27+
label: Misc discussion on performance
28+
description: >
29+
Anything about the performance.
30+
validations:
31+
required: false
32+
- type: textarea
33+
attributes:
34+
label: Your current environment (if you think it is necessary)
35+
description: |
36+
Please run the following and paste the output below.
37+
**TODO: Add script to our project to collect the unifiedcache runtime environment, this following example comes from vllm-ascend**
38+
```sh
39+
npu-smi info
40+
cat /usr/local/Ascend/ascend-toolkit/latest/"$(uname -i)"-linux/ascend_toolkit_install.info
41+
wget https://raw.githubusercontent.com/vllm-project/vllm/main/collect_env.py
42+
# For security purposes, please feel free to check the contents of collect_env.py before running it.
43+
python collect_env.py
44+
```
45+
It is suggested to download and execute the latest script, as vllm might frequently update the diagnosis information needed for accurately and quickly responding to issues.
46+
value: |
47+
```text
48+
The output of `python collect_env.py`
49+
```
50+
validations:
51+
required: false
52+
- type: markdown
53+
attributes:
54+
value: >
55+
Thanks for contributing 🎉!
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: 🎲 Others
2+
description: Submit a discussion as you like. Note that developers are heavily overloaded and we mainly rely on community users to answer these issues.
3+
title: "[Misc]: "
4+
labels: ["misc"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
#### Before submitting an issue, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ModelEngine-Group/unified-cache-management/issues?q=is%3Aissue%20sort%3Acreated-desc).
11+
- type: textarea
12+
attributes:
13+
label: Anything you want to discuss about unifiedcache.
14+
description: >
15+
Anything you want to discuss about unifiedcache.
16+
validations:
17+
required: true
18+
- type: markdown
19+
attributes:
20+
value: >
21+
Thanks for contributing 🎉!

0 commit comments

Comments
 (0)