diff --git a/docs/source/en/model_doc/cohere2.md b/docs/source/en/model_doc/cohere2.md index 24f649666395..a4836e7790cf 100644 --- a/docs/source/en/model_doc/cohere2.md +++ b/docs/source/en/model_doc/cohere2.md @@ -1,43 +1,115 @@ -# Cohere - -
-PyTorch -FlashAttention -SDPA -Tensor parallelism +
+
+ PyTorch + FlashAttention + SDPA + Tensor parallelism +
-## Overview -[C4AI Command R7B](https://cohere.com/blog/command-r7b) is an open weights research release of a 7B billion parameter model developed by Cohere and Cohere For AI. It has advanced capabilities optimized for various use cases, including reasoning, summarization, question answering, and code. The model is trained to perform sophisticated tasks including Retrieval Augmented Generation (RAG) and tool use. The model also has powerful agentic capabilities that can use and combine multiple tools over multiple steps to accomplish more difficult tasks. It obtains top performance on enterprise-relevant code use cases. C4AI Command R7B is a multilingual model trained on 23 languages. -The model features three layers with sliding window attention (window size 4096) and ROPE for efficient local context modeling and relative positional encoding. A fourth layer uses global attention without positional embeddings, enabling unrestricted token interactions across the entire sequence. +# Cohere2 + +[Cohere Command R7B](https://cohere.com/blog/command-r7b) is an open weights research release of a 7B billion parameter model. It is a multilingual model trained on 23 languages and has a context window of 128k. The model features three layers with sliding window attention and ROPE for efficient local context modeling and relative positional encoding. A fourth layer uses global attention without positional embeddings, enabling unrestricted token interactions across the entire sequence. + +This model is optimized for speed, cost-performance, and compute resources. + +You can find all the original Command-R checkpoints under the [Command Models](https://huggingface.co/collections/CohereForAI/command-models-67652b401665205e17b192ad) collection. -The model has been trained on 23 languages: English, French, Spanish, Italian, German, Portuguese, Japanese, Korean, Arabic, Chinese, Russian, Polish, Turkish, Vietnamese, Dutch, Czech, Indonesian, Ukrainian, Romanian, Greek, Hindi, Hebrew, and Persian. -## Usage tips -The model and tokenizer can be loaded via: +> [!TIP] +> Click on the Cohere models in the right sidebar for more examples of how to apply Cohere to different language tasks. + +The example below demonstrates how to generate text with [`Pipeline`] or the [`AutoModel`] class, and from the command line. + + + ```python -# pip install transformers -from transformers import AutoTokenizer, AutoModelForCausalLM +import torch +from transformers import pipeline + +pipeline = pipeline( + task="text-generation", + model="CohereLabs/c4ai-command-r7b-12-2024", + torch_dtype=torch.float16, + device_map=0 +) -model_id = "CohereForAI/c4ai-command-r7b-12-2024" -tokenizer = AutoTokenizer.from_pretrained(model_id) -model = AutoModelForCausalLM.from_pretrained(model_id) +messages = [ + {"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"}, +] +pipeline(messages) +``` + + + -# Format message with the command-r chat template -messages = [{"role": "user", "content": "Hello, how are you?"}] -input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt") +```python +import torch +from transformers import AutoTokenizer, AutoModelForCausalLM -gen_tokens = model.generate( +tokenizer = AutoTokenizer.from_pretrained("CohereLabs/c4ai-command-r7b-12-2024") +model = AutoModelForCausalLM.from_pretrained( + "CohereLabs/c4ai-command-r7b-12-2024", + torch_dtype=torch.float16, + device_map="auto", + attn_implementation="sdpa" +) + +# format message with the Command-R chat template +messages = [{"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"}] +input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda") +output = model.generate( input_ids, max_new_tokens=100, do_sample=True, temperature=0.3, + cache_implementation="static", ) +print(tokenizer.decode(output[0], skip_special_tokens=True)) +``` -gen_text = tokenizer.decode(gen_tokens[0]) -print(gen_text) + + + +```bash +# pip install -U flash-attn --no-build-isolation +transformers-cli chat CohereLabs/c4ai-command-r7b-12-2024 --torch_dtype auto --attn_implementation flash_attention_2 +``` + + + + +Quantization reduces the memory burden of large models by representing the weights in a lower precision. Refer to the [Quantization](../quantization/overview.md) overview for more available quantization backends. + +The example below uses [bitsandbytes](../quantization/bitsandbytes.md) to quantize the weights to 4-bits. + +```python +import torch +from transformers import BitsAndBytesConfig, AutoTokenizer, AutoModelForCausalLM + +bnb_config = BitsAndBytesConfig(load_in_4bit=True) +tokenizer = AutoTokenizer.from_pretrained("CohereLabs/c4ai-command-r7b-12-2024") +model = AutoModelForCausalLM.from_pretrained( + "CohereLabs/c4ai-command-r7b-12-2024", + torch_dtype=torch.float16, + device_map="auto", + quantization_config=bnb_config, + attn_implementation="sdpa" +) + +# format message with the Command-R chat template +messages = [{"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"}] +input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda") +output = model.generate( + input_ids, + max_new_tokens=100, + do_sample=True, + temperature=0.3, + cache_implementation="static", +) +print(tokenizer.decode(output[0], skip_special_tokens=True)) ``` ## Cohere2Config