You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Doc] Move Release Compatibility Matrix to top and remove v0.7.x rc info (#799)
### What this PR does / why we need it?
- Move Release Compatibility Matrix to top
- Remove v0.7.x rc info because v0.7.3 final release alread published
- Rename vllm-ascend to vLLM Ascend
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Preview
Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
Copy file name to clipboardExpand all lines: docs/source/developer_guide/versioning_policy.md
+31-34Lines changed: 31 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Starting with vLLM 0.7.x, the vLLM Ascend Plugin ([vllm-project/vllm-ascend](htt
4
4
5
5
## vLLM Ascend Plugin versions
6
6
7
-
Each vllm-ascend release will be versioned: `v[major].[minor].[micro][rcN][.postN]` (such as
7
+
Each vLLM Ascend release will be versioned: `v[major].[minor].[micro][rcN][.postN]` (such as
8
8
`v0.7.3rc1`, `v0.7.3`, `v0.7.3.post1`)
9
9
10
10
-**Final releases**: will typically be released every **3 months**, will take the vLLM upstream release plan and Ascend software product release plan into comprehensive consideration.
@@ -13,12 +13,36 @@ Each vllm-ascend release will be versioned: `v[major].[minor].[micro][rcN][.post
13
13
14
14
For example:
15
15
-`v0.7.x`: it's the first final release to match the vLLM `v0.7.x` version.
16
-
-`v0.7.3rc1`: will be the first pre version of vllm-ascend.
16
+
-`v0.7.3rc1`: will be the first pre version of vLLM Ascend.
17
17
-`v0.7.3.post1`: will be the post release if the `v0.7.3` release has some minor errors.
18
18
19
+
## Release Compatibility Matrix
20
+
21
+
Following is the Release Compatibility Matrix for vLLM Ascend Plugin:
-**main**: main branch，corresponds to the vLLM main branch and latest 1 or 2 release version. It is continuously monitored for quality through Ascend CI.
24
48
-**vX.Y.Z-dev**: development branch, created with part of new releases of vLLM. For example, `v0.7.3-dev` is the dev branch for vLLM `v0.7.3` version.
@@ -36,9 +60,9 @@ The branch status will be in one of the following states:
36
60
37
61
### Branch state
38
62
39
-
Note that vllm-ascend will only be released for a certain vLLM release version rather than all versions. Hence, You might see only part of versions have dev branches (such as only `0.7.1-dev` / `0.7.3-dev` but no `0.7.2-dev`), this is as expected.
63
+
Note that vLLM Ascend will only be released for a certain vLLM release version rather than all versions. Hence, You might see only part of versions have dev branches (such as only `0.7.1-dev` / `0.7.3-dev` but no `0.7.2-dev`), this is as expected.
40
64
41
-
Usually, each minor version of vLLM (such as 0.7) will correspond to a vllm-ascend version branch and support its latest version (for example, we plan to support version 0.7.3) as following shown:
65
+
Usually, each minor version of vLLM (such as 0.7) will correspond to a vLLM Ascend version branch and support its latest version (for example, we plan to support version 0.7.3) as following shown:
@@ -48,9 +72,9 @@ Usually, each minor version of vLLM (such as 0.7) will correspond to a vllm-asce
48
72
49
73
### Backward compatibility
50
74
51
-
For main branch, vllm-ascend should works with vLLM main branch and latest 1 or 2 release version. So to ensure the backward compatibility, we will do the following:
75
+
For main branch, vLLM Ascend should works with vLLM main branch and latest 1 or 2 release version. So to ensure the backward compatibility, we will do the following:
52
76
- Both main branch and target vLLM release is tested by Ascend E2E CI. For example, currently, vLLM main branch and vLLM 0.8.4 are tested now.
53
-
- For code changes, we will make sure that the changes are compatible with the latest 1 or 2 vLLM release version as well. In this case, vllm-ascend introduced a version check machinism inner the code. It'll check the version of installed vLLM pacakge first to decide which code logic to use. If users hit the `InvalidVersion` error, it sometimes means that they have installed an dev/editable version of vLLM package. In this case, we provide the env variable `VLLM_VERSION` to let users specify the version of vLLM package to use.
77
+
- For code changes, we will make sure that the changes are compatible with the latest 1 or 2 vLLM release version as well. In this case, vLLM Ascend introduced a version check machinism inner the code. It'll check the version of installed vLLM pacakge first to decide which code logic to use. If users hit the `InvalidVersion` error, it sometimes means that they have installed an dev/editable version of vLLM package. In this case, we provide the env variable `VLLM_VERSION` to let users specify the version of vLLM package to use.
54
78
- For documentation changes, we will make sure that the changes are compatible with the latest 1 or 2 vLLM release version as well. Note should be added if there are any breaking changes.
55
79
56
80
## Document Branch Policy
@@ -73,30 +97,3 @@ As shown above:
73
97
every 3 months, a development version (aka the POC version) every month, and a nightly version every day.
74
98
The PyPi stable version **CAN** be used in vLLM Ascend final version, the monthly dev version **ONLY CANN** be used in
75
99
vLLM Ascend RC version for rapid iteration, the nightly version **CANNOT** be used in vLLM Ascend any version and branches.
76
-
77
-
## Release Compatibility Matrix
78
-
79
-
Following is the Release Compatibility Matrix for vLLM Ascend Plugin:
0 commit comments