Upload README.md

README.md

@@ -1,199 +1,326 @@
 ---
+language:
+- multilingual
+license: apache-2.0
 library_name: transformers
-tags: []
+tags:
+- nlp
+- code
+- vision
+- chemistry
+- engineering
+- biology
+- bio-inspired
+- text-generation-inference
+- materials science
+pipeline_tag: image-text-to-text
+inference:
+  parameters:
+    temperature: 0.3
+widget:
+- messages:
+  - role: user
+    content: <|image_1|>Can you describe what you see in the image?
 ---
+## Model Summary
 
-# Model Card for Model ID
+Cephalo is 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 in human-AI or multi-agent AI frameworks. 
 
-<!-- Provide a quick summary of what the model is/does. -->
+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. 
 
-## Model Details
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/623ce1c6b66fedf374859fe7/kl5GWBP9WS0D4uwd1t3S7.png)
 
-### Model Description
+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.
 
-<!-- Provide a longer summary of what this model is. -->
+This version of Cephalo, lamm-mit/Cephalo-Phi-3-vision-128k-4b-alpha, is based on the HuggingFaceM4/idefics2-8b-chatty model. The model was trained on a combination of scientific text-image data extracted from Wikipedia and scientific papers. For further details on the base model, see: https://huggingface.co/HuggingFaceM4/idefics2-8b-chatty. More details about technical aspects of the model, training and example applications to materials science problems are provided in the paper (reference at the bottom).
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+### Chat Format
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+The lamm-mit/Cephalo-Idefics-2-vision-8b-alpha is suiteable for one or more image inputs, wih prompts using the chat format as follows:
 
-### Model Sources [optional]
+```raw
+User: You carefully study the image, and respond accurately, but succinctly. Think step-by-step.
+<image>What is shown in this image, and what is the relevance for materials design? Include a discussion of multi-agent AI.<end_of_utterance>
+Assistant:
+```
+where the model generates the text after `Assistant:` . For multi-turn conversations, the prompt should be formatted as follows:
 
-<!-- Provide the basic links for the model. -->
+```raw
+User: You carefully study the image, and respond accurately, but succinctly. Think step-by-step.
+<image>What is shown in this image, and what is the relevance for materials design? Include a discussion of multi-agent AI.<end_of_utterance>
+Assistant: The image depicts ants climbing a vertical surface using their legs and claws. This behavior is observed in nature and can inspire the design of multi-agent AI systems that mimic the coordinated movement of these insects. The relevance lies in the potential application of such systems in robotics and materials science, where efficient and adaptive movement is crucial.<end_of_utterance>
+User: How could this be used to design a fracture resistant material?<end_of_utterance>
+Assistant:
+```
+
+If you need to manually set the chat template:
+
+```
+IDEFICS2_CHAT_TEMPLATE = """{% if not add_generation_prompt is defined %}{% set add_generation_prompt = false %}{% endif %}A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. {% for message in messages %}{% if message['role'] == 'user' %}USER: {% else %}ASSISTANT: {% endif %}{% for item in message['content'] %}{% if item['type'] == 'text' %}{{ item['text'] }}{% elif item['type'] == 'image' %}<image>{% endif %}{% endfor %}{% if message['role'] == 'user' %} {% else %}{{eos_token}}{% endif %}{% endfor %}{% if add_generation_prompt %}ASSISTANT: {% endif %}"""
+```
+
+### Sample inference code
+
+This code snippets show how to get quickly started on a GPU:
+
+```python
+from PIL import Image 
+import requests 
+
+DEVICE='cuda:0'
+
+from transformers import AutoProcessor, Idefics2ForConditionalGeneration 
+from tqdm.notebook import tqdm
+ 
+model_id='lamm-mit/Cephalo-Idefics-2-vision-8b-alpha'
+
+model = Idefics2ForConditionalGeneration.from_pretrained(  model_id,
+                                                           torch_dtype=torch.bfloat16, #if your GPU allows
+                                                           _attn_implementation="flash_attention_2", #make sure Flash Attention 2 is installed
+                                                           trust_remote_code=True,
+                                                        ).to (DEVICE)
+processor = AutoProcessor.from_pretrained(
+    f"{model_id}",
+    do_image_splitting=True
+)
+```
+See section towards the end for more comments on model optimization, including quantization.
+
+
+If you need to manually set the chat template:
+
+```python
+IDEFICS2_CHAT_TEMPLATE = """{% if not add_generation_prompt is defined %}{% set add_generation_prompt = false %}{% endif %}A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. {% for message in messages %}{% if message['role'] == 'user' %}USER: {% else %}ASSISTANT: {% endif %}{% for item in message['content'] %}{% if item['type'] == 'text' %}{{ item['text'] }}{% elif item['type'] == 'image' %}<image>{% endif %}{% endfor %}{% if message['role'] == 'user' %} {% else %}{{eos_token}}{% endif %}{% endfor %}{% if add_generation_prompt %}ASSISTANT: {% endif %}"""
+tokenizer = AutoTokenizer.from_pretrained(base_model_id, use_fast=True)
+tokenizer.chat_template = IDEFICS2_CHAT_TEMPLATE
+processor.tokenizer = tokenizer
+```
+
+Simple inference example:
+
+```
+from transformers.image_utils import load_image
+
+image = load_image("https://d2r55xnwy6nx47.cloudfront.net/uploads/2018/02/Ants_Lede1300.jpg")
+
+# Create inputs
+messages = [
+    {
+        "role": "user",
+        "content": [
+            {"type": "image"},
+            {"type": "text", "text": "What is shown in this image, and what is the relevance for materials design? Include a discussion of multi-agent AI."},
+        ]
+    },
+]
+prompt = processor.apply_chat_template(messages, add_generation_prompt=True)
+
+# Get inputs using the processor
+inputs = processor(text=prompt, images=[image], return_tensors="pt")
+inputs = {k: v.to(DEVICE) for k, v in inputs.items()}
+
+# Generate
+generated_ids = model.generate(**inputs, max_new_tokens=500)
+generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
+
+print(generated_texts)
+```
+
+Next we provide a convenience function for inference. This function takes the model, processor, question, and images, along with messages and images objects for repeated chat-like interactions with the model.
+
+```python
+def ask_about_image (model, processor, question, 
+                     images_input=[], 
+                     verbatim=False,
+                     temperature=0.1,
+                     show_image=False,
+                     system="You are a biomaterials scientist who responds accurately. ", 
+                     init_instr = "",
+                     show_conversation=True,
+                     max_new_tokens=256, 
+                     messages=[], 
+                     images=[], 
+                     use_Markdown=False,
+                    ):
+    
+   
+    query = question
+    images_input=ensure_list(images_input)
+    if len (images)==0:
+        if len (images_input)>0:
+            for image in tqdm (images_input) :
+                if is_url(image):
+                    image= load_image(image)
+                images.append (image)
+                
+                if show_image:
+                    display ( image )
+    if len (messages)==0:
+       
+        base_message = {
+            "role": "user",
+            "content": [
+                {"type": "text", "text": system + init_instr},
+                # Image messages will be added dynamically here
+                {"type": "text", "text": query}
+            ]
+        }
+        
+        # Ensure the images_input is a list
+        images_input = ensure_list(images_input)
+        
+        # Add image messages dynamically
+        image_messages = [{"type": "image"} for _ in images_input]
+        base_message["content"][1:1] = image_messages  # Insert image messages before the last text message
+        
+        # Append the constructed message to messages list
+        messages.append(base_message)
+
+    else:
+        messages.append (
+            {
+                "role": "user",
+                "content": [
+                    {"type": "text", "text": query
+                    }
+                ]
+            }
+        )
+    if verbatim:
+        print (messages)
+        
+    text = processor.apply_chat_template(messages, add_generation_prompt=True)
+    inputs = processor(text=[text.strip()], images=images, return_tensors="pt", padding=True).to(DEVICE)
+     
+    generated_ids = model.generate(**inputs, max_new_tokens=max_new_tokens, temperature=temperature, do_sample=True)
+    generated_texts = processor.batch_decode(generated_ids[:, inputs["input_ids"].size(1):], skip_special_tokens=True)
+
+    messages.append (
+        {
+            "role": "assistant",
+            "content": [ {"type": "text", "text": generated_texts[0]}, ]
+        }
+    )
+    formatted_conversation = format_conversation(messages, images)
+    
+    # Display the formatted conversation, e.g. in Jupyter Notebook
+    if show_conversation:
+     
+        if use_Markdown:
+            display(Markdown(formatted_conversation))
+        else:
+            display(HTML(formatted_conversation))
+
+    return generated_texts, messages, images
+
+question = "What is shown in this image, and what is the relevance for materials design? Include a discussion of multi-agent AI."
+
+url1 = "https://d2r55xnwy6nx47.cloudfront.net/uploads/2018/02/Ants_Lede1300.jpg" 
+
+response, messages,images= ask_about_image ( model, processor, question, 
+                                             images_input=[url1,],
+                                             temperature=0.1,
+                                             system= '', init_instr='You carefully study the image, and respond accurately, but succinctly. Think step-by-step.\n\n', 
+                                             show_conversation=True,
+                                             max_new_tokens=512, messages=[], images=[])
+```
+
+Sample output:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/623ce1c6b66fedf374859fe7/5n6oRNHrfwHkBX0QertZp.png)
+<small>Image by [Vaishakh Manohar](https://www.quantamagazine.org/the-simple-algorithm-that-ants-use-to-build-bridges-20180226/)</small>
+
+<pre style="white-space: pre-wrap;">
+The image depicts a group of ants moving in a coordinated manner, demonstrating their ability to navigate complex environments and adapt to changing conditions. This behavior is relevant for materials design because it highlights the potential of multi-agent AI systems to mimic natural systems and develop new materials with enhanced properties.
+
+Multi-agent AI refers to the use of multiple autonomous agents working together to solve complex problems. These agents can learn from each other and adapt to new situations, similar to how ants can navigate their environment and communicate with one another. By applying these principles to materials design, researchers can develop new materials that exhibit improved performance, such as enhanced strength, flexibility, and adaptability.
+
+The relevance of this image for materials design lies in the inspiration it provides for developing new materials that can mimic the natural efficiency and adaptability of ants. By studying the behavior of ants, researchers can gain insights into how to design materials that can respond dynamically to changes in their environment, leading to improved performance and functionality.
+</pre>
+
+## Dataset generation
+
+The schematic below shows a visualization of the approach to generate datasets for training the vision model. 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.
+
+The image below shows reproductions of two representative pages of the scientific article (here, Spivak, Buehler, et al., 2011), and how they are used to extract visual scientific data for training the Cephalo model.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/623ce1c6b66fedf374859fe7/qHURSBRWEDgHy4o56escN.png)
+
+# Further model optimizations
+
+If your GPU allows, load and run inference in half precision (`torch.float16` or `torch.bfloat16`).
+
+```diff
+model = AutoModelForVision2Seq.from_pretrained(
+    "lamm-mit/Cephalo-Idefics-2-vision-8b-alpha",
++    torch_dtype=torch.float16,    
+).to(DEVICE)
+```
+
+**Vision encoder efficiency**
+
+Given the high resolution supported, the vision part of the model can be memory hungry depending on your configuration. If you are GPU-memory-constrained, you can:
+- **deactivate the image splitting.** To do so, add `do_image_splitting=False` when initializing the processor (`AutoProcessor.from_pretrained`). There are no changes required on the model side. Note that only the sft model has been trained with image splitting.
+- **decrease the maximum image resolution.** To do so, add `size= {"longest_edge": 448, "shortest_edge": 378}` when initializing the processor (`AutoProcessor.from_pretrained`). In particular, the `longest_edge` value can be adapted to fit the need (the default value is `980`). We recommend using values that are multiples of 14. There are no changes required on the model side.
+
+`do_image_splitting=True` is especially needed to boost performance on complex tasks where a very large image is used as input. The model was fine-tuned with image splitting turned on. For simple tasks, this argument can be safely set to `False`.
+
+**Using Flash-attention 2 to speed up generation**
+
+<details><summary>Click to expand.</summary>
+
+Mke sure to install `flash-attn`. Refer to the [original repository of Flash Attention](https://github.com/Dao-AILab/flash-attention) for the package installation. Simply change the snippet above with: 
+
+```diff
+model = AutoModelForVision2Seq.from_pretrained(
+    "lamm-mit/Cephalo-Idefics-2-vision-8b-alpha",
++    torch_dtype=torch.bfloat16,    
++    _attn_implementation="flash_attention_2",
+).to(DEVICE)
+```
+
+</details>
+
+**4 bit quantization with bitsandbytes**
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+<details><summary>Click to expand.</summary>
+It is possible to load Idefics2 in 4bits with `bitsandbytes`. Make sure that you have `accelerate` and `bitsandbytes` installed.
 
-## Uses
+```diff
++ from transformers import BitsAndBytesConfig
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+quantization_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_use_double_quant=True,
+    bnb_4bit_compute_dtype=torch.bfloat16
+)
+model = AutoModelForVision2Seq.from_pretrained(
+    "lamm-mit/Cephalo-Idefics-2-vision-8b-alpha",
++    torch_dtype=torch.bfloat16,    
++    quantization_config=quantization_config,
+).to(DEVICE)
+```
 
-### Direct Use
+</details>
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+## Citation
 
-### Downstream Use [optional]
+Please cite as:
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+```bibtex
+@article{Buehler_Cephalo_2024,
+    title   = {Cephalo, a series of multi-modal vision-language models for bio-inspired materials and mechanics},
+    author  = {M.J. Buehler},
+    journal = {},
+    year    = {2024},
+    volume  = {},
+    pages   = {},
+    url     = {}
+}
+```