Create README.md

README.md

@@ -0,0 +1,90 @@
+---
+license: apache-2.0
+language:
+- multilingual
+pipeline_tag: text-generation
+tags:
+- nlp
+- code
+- vision
+inference:
+  parameters:
+    temperature: 0.3
+widget:
+  - messages:
+      - role: user
+        content: <|image_1|>Can you describe what you see in the image?
+---
+## Model Summary
+
+We introduce Cephalo, a series of multimodal materials science focused vision large language models (V-LLMs) designed to integrate visual and linguistic data for advanced understanding and interaction. 
+
+A novel aspect of Cephalo's development is the innovative dataset generation method. The extraction process employs advanced algorithms to accurately detect and separate images and their corresponding textual descriptions from complex PDF documents. It involves extracting images and captions from PDFs to create well-reasoned image-text pairs, utilizing large language models (LLMs) for natural language processing. These image-text pairs are then refined and validated through LLM-based NLP processing, ensuring high-quality and contextually relevant data for training.
+
+Cephalo can interpret complex visual scenes and generating contextually accurate language descriptions and answer queries. 
+
+The model is developed to process diverse inputs, including images and text, facilitating a broad range of applications such as image captioning, visual question answering, and multimodal content generation. 
+
+The architecture combines a vision encoder model and an autoregressive transformer to process complex natural language understanding. 
+
+Cephalo provides a robust framework for multimodal interaction and understanding, including the development of complex generative pipelines to create 2D and 3D renderings of material microstructures as input for additive manufacturing methods.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/623ce1c6b66fedf374859fe7/FsdGboq7FinNHOJnwYfWu.png)
+
+This version of Cephalo, lamm-mit/Cephalo-Phi-3-vision-128k, is based on the Phi-3-Vision-128K-Instruct model. Further details, see: https://huggingface.co/microsoft/Phi-3-vision-128k-instruct. 
+
+### Chat Format
+
+Given the nature of the training data, the Cephalo-Phi-3-vision-128k model is best suited for a single image input wih prompts using the chat format as follows. 
+You can provide the prompt as a single image with a generic template as follow:
+```markdown
+<|user|>\n<|image_1|>\n{prompt}<|end|>\n<|assistant|>\n 
+```
+
+where the model generates the text after `<|assistant|>` . For multi-turn conversations, the prompt should be formatted as follows:
+
+```markdown
+<|user|>\n<|image_1|>\n{prompt_1}<|end|>\n<|assistant|>\n{response_1}<|end|>\n<|user|>\n{prompt_2}<|end|>\n<|assistant|>\n 
+```
+
+### Sample inference code
+
+This code snippets show how to get quickly started on a GPU:
+
+```python
+from PIL import Image 
+import requests 
+from transformers import AutoModelForCausalLM 
+from transformers import AutoProcessor 
+
+model_id = "lamm-mit/Cephalo-Phi-3-vision-128k" 
+
+model = AutoModelForCausalLM.from_pretrained(model_id, device_map="cuda", trust_remote_code=True, torch_dtype="auto")
+
+processor = AutoProcessor.from_pretrained(model_id, trust_remote_code=True) 
+
+messages = [ 
+    {"role": "user", "content": "<|image_1|>\nWhat is shown in this image?"}, 
+    ] 
+
+url = "https://d2r55xnwy6nx47.cloudfront.net/uploads/2018/02/Ants_Lede1300.jpg" 
+image = Image.open(requests.get(url, stream=True).raw) 
+
+prompt = processor.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+
+inputs = processor(prompt, [image], return_tensors="pt").to("cuda:0") 
+
+generation_args = { 
+    "max_new_tokens": 500, 
+    "temperature": 0.0, 
+    "do_sample": False, 
+} 
+
+generate_ids = model.generate(**inputs, eos_token_id=processor.tokenizer.eos_token_id, **generation_args) 
+
+# remove input tokens 
+generate_ids = generate_ids[:, inputs['input_ids'].shape[1]:]
+response = processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0] 
+
+print(response) 
+```