Update README.md

README.md

@@ -27,6 +27,31 @@ We release InternLM-XComposer2 series in two versions:
 - InternLM-XComposer2-VL: The pretrained VLLM model with InternLM2 as the initialization of the LLM, achieving strong performance on various multimodal benchmarks.
 - InternLM-XComposer2: The finetuned VLLM for *Free-from Interleaved Text-Image Composition*.
 
+## Quickstart
+We provide a simple example to show how to use InternLM-XComposer with 🤗 Transformers.
+```python
+import torch
+from transformers import AutoModel, AutoTokenizer
+
+torch.set_grad_enabled(False)
+
+# init model and tokenizer
+model = AutoModel.from_pretrained('internlm/internlm-xcomposer2-vl-7b', trust_remote_code=True).cuda().eval()
+tokenizer = AutoTokenizer.from_pretrained('internlm/internlm-xcomposer2-vl-7b', trust_remote_code=True)
+
+query = '<ImageHere>Please describe this image in detail.'
+image = './image1.webp'
+with torch.cuda.amp.autocast():
+  response, _ = model.chat(tokenizer, query=query, image=image, history=[], do_sample=False)
+print(response)
+#The image features a quote by Oscar Wilde, "Live life with no excuses, travel with no regret,"
+# set against a backdrop of a breathtaking sunset. The sky is painted in hues of pink and orange,
+# creating a serene atmosphere. Two silhouetted figures stand on a cliff, overlooking the horizon.
+# They appear to be hiking or exploring, embodying the essence of the quote.
+# The overall scene conveys a sense of adventure and freedom, encouraging viewers to embrace life without hesitation or regrets.
+
+```
+
 ### Import from Transformers
 To load the InternLM-XComposer2-VL-7B model using Transformers, use the following code:
 ```python