[Model] Cohere CommandR+

[saurabhdash2512]

FILL IN THE PR DESCRIPTION HERE

Adding support for Cohere CommandR+ (CohereForAI/c4ai-command-r-plus)

@youkaichao Could you please take a look at the changes?

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE

---

PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

• [Bugfix] for bug fixes.
• [CI/Build] for build or continuous integration improvements.
• [Doc] for documentation fixes and improvements.
• [Model] for adding a new model or improving an existing model. Model name should appear in the title.
• [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
• [Kernel] for changes affecting CUDA kernels or other compute kernels.
• [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
• [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
• [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

• We adhere to Google Python style guide and Google C++ style guide.
• Pass all linter checks. Please use format.sh to format your code.
• The code need to be well-documented to ensure future contributors can easily understand the code.
• Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
• Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

• After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
• After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
• After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
• Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

[saurabhdash2512]

The model executes correctly but gives this error at the end. Does any one know what might be the issue?

Exception ignored in: <function NCCLCommunicator.__del__ at 0x7fb652b996c0>
Traceback (most recent call last):
  File "/workspace/vllm/vllm/model_executor/parallel_utils/pynccl.py", line 264, in __del__
TypeError: 'NoneType' object is not callable

[esmeetu]

The model executes correctly but gives this error at the end. Does any one know what might be the issue?

Exception ignored in: <function NCCLCommunicator.__del__ at 0x7fb652b996c0>
Traceback (most recent call last):
  File "/workspace/vllm/vllm/model_executor/parallel_utils/pynccl.py", line 264, in __del__
TypeError: 'NoneType' object is not callable

Is this error related this PR? If not, you can submit a new issue with detail env and error info.

[saurabhdash2512]

The model executes correctly but gives this error at the end. Does any one know what might be the issue?

Exception ignored in: <function NCCLCommunicator.__del__ at 0x7fb652b996c0>
Traceback (most recent call last):
  File "/workspace/vllm/vllm/model_executor/parallel_utils/pynccl.py", line 264, in __del__
TypeError: 'NoneType' object is not callable

Is this error related this PR? If not, you can submit a new issue with detail env and error info.

Yup, it's related to the changes I've made.

[esmeetu]

@saurabhdash2512 I see you used tensor parallelism for LayerNorm, could you try without splitting norm weight?

[saurabhdash2512]

@saurabhdash2512 I see you used tensor parallelism for LayerNorm, could you try without splitting norm weight?

The norm weights need to be split

[esmeetu]

Hmm, sorry i missed that it's related to query and key vector normalization. @youkaichao Any ideas about that pynccl error?

[WoosukKwon]

@saurabhdash2512 @esmeetu I updated this branch with the current main and was able to successfully run the model without the error. Could you please try again?

[saurabhdash2512]

@saurabhdash2512 @esmeetu I updated this branch with the current main and was able to successfully run the model without the error. Could you please try again?
@WoosukKwon
I get this error now:

TypeError: reshape_and_cache(): incompatible function arguments. The following argument types are supported:
    1. (arg0: torch.Tensor, arg1: torch.Tensor, arg2: torch.Tensor, arg3: torch.Tensor, arg4: torch.Tensor, arg5: str) -> None

[WoosukKwon]

@saurabhdash2512 You have to rebuild vLLM since the kernel has changed.

[saurabhdash2512]

@saurabhdash2512 You have to rebuild vLLM since the kernel has changed.

@WoosukKwon
I still see the same log.
If it helps this is the nccl version

(RayWorkerVllm pid=3991115) INFO 04-04 15:33:36 pynccl_utils.py:45] vLLM is using nccl==2.18.1

[WoosukKwon]

@youkaichao Could you please take a look at the issue?

[youkaichao]

Exception ignored in: <function NCCLCommunicator.del at 0x7fb652b996c0>
Traceback (most recent call last):
File "/workspace/vllm/vllm/model_executor/parallel_utils/pynccl.py", line 264, in del
TypeError: 'NoneType' object is not callable

Seems to be related with #3702 , about the cleanup order of objects.

Maybe related with this code, where _c_ncclCommDestroy is already destructed:

vllm/vllm/model_executor/parallel_utils/pynccl.py

Lines 270 to 274 in ca81ff5

	def __del__(self):
	# `dist` module might have been already destroyed
	if hasattr(dist, 'destroy_process_group'):
	dist.destroy_process_group()
	_c_ncclCommDestroy(self.comm)

But anyway, this says Exception ignored, so it should not cause problem.

@saurabhdash2512 does this "error message" break your program?

[saurabhdash2512]

Exception ignored in: <function NCCLCommunicator.del at 0x7fb652b996c0>
Traceback (most recent call last):
File "/workspace/vllm/vllm/model_executor/parallel_utils/pynccl.py", line 264, in del
TypeError: 'NoneType' object is not callable

Seems to be related with #3702 , about the cleanup order of objects.

Maybe related with this code, where _c_ncclCommDestroy is already destructed:

vllm/vllm/model_executor/parallel_utils/pynccl.py

Lines 270 to 274 in ca81ff5

	def __del__(self):
	# `dist` module might have been already destroyed
	if hasattr(dist, 'destroy_process_group'):
	dist.destroy_process_group()
	_c_ncclCommDestroy(self.comm)

But anyway, this says Exception ignored, so it should not cause problem.

@saurabhdash2512 does this "error message" break your program?

@youkaichao Nope, it doesnt. Works just fine otherwise.

[WoosukKwon]

@saurabhdash2512 do you have the same issue for other models? Say, could you run facebook/opt-125m with the same TP degree and check whether the same error message appears?

[WoosukKwon]

@saurabhdash2512 Thanks for contributing to vLLM! Super excited to have this SOTA model. Looking forward to what will be built on top of the model!

*I believe the issue above is orthogonal to the current PR. So let's merge this first.

[huyang19881115]

Cohere CommandR+ 使用vllm是如何启动的呢？有启动的例子的吗？必须vllm 0.4.1 版本以及以上的吗？

[huyang19881115]

Traceback (most recent call last):
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/runpy.py", line 196, in _run_module_as_main
return _run_code(code, main_globals, None,
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/runpy.py", line 86, in _run_code
exec(code, run_globals)
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/site-packages/vllm/entrypoints/openai/api_server.py", line 168, in
engine = AsyncLLMEngine.from_engine_args(
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/site-packages/vllm/engine/async_llm_engine.py", line 346, in from_engine_args
engine_config = engine_args.create_engine_config()
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/site-packages/vllm/engine/arg_utils.py", line 520, in create_engine_config
model_config = ModelConfig(
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/site-packages/vllm/config.py", line 131, in init
self._verify_quantization()
File "/data/miniconda3/minicondaenv/envs/vllm4/lib/python3.10/site-packages/vllm/config.py", line 188, in _verify_quantization
raise ValueError(
ValueError: Quantization method specified in the model config (bitsandbytes) does not match the quantization method specified in the quantization argument (marlin).