Update README.md

README.md

@@ -1,26 +1,117 @@
 ---
-license: mit
+license: cc-by-nc-4.0
 datasets:
 - vidore/colpali_train_set
+language:
+- en
 base_model:
 - Qwen/Qwen2-VL-7B-Instruct
-pipeline_tag: visual-document-retrieval
-library_name: transformers
 tags:
 - vidore
+- multimodal-embedding
+library_name: peft
+pipeline_tag: visual-document-retrieval
 ---
+# IEIT-Systems ColQwen2-7B: Visual Retriever based on Qwen2-VL-7B-Instruct with ColBERT strategy
+
+### This is the base version trained with batch_size 8x64 for 5 epoch and with the updated pad token
+
+ColQwen is a model based on a novel model architecture and training strategy based on Vision Language Models (VLMs) to efficiently index documents from their visual features.
+It is a [Qwen2-VL-7B](https://huggingface.co/Qwen/Qwen2-VL-7B-Instruct) extension that generates [ColBERT](https://arxiv.org/abs/2004.12832)- style multi-vector representations of text and images. 
+It was introduced in the paper [ColPali: Efficient Document Retrieval with Vision Language Models](https://arxiv.org/abs/2407.01449) and first released in [this repository](https://github.com/ManuelFay/colpali)
+
+This version is the untrained base version to guarantee deterministic projection layer initialization.
+<p align="center"><img width=800 src="https://github.com/illuin-tech/colpali/blob/main/assets/colpali_architecture.webp?raw=true"/></p>
+
+## Version specificity
+
+
+This model takes dynamic image resolutions in input and does not resize them, changing their aspect ratio as in ColPali.
+Maximal resolution is set so that 768 image patches are created at most. Experiments show clear improvements with larger amounts of image patches, at the cost of memory requirements.
+
+This version is trained with `colpali-engine==0.3.4`.
+
+Data is the same as the ColPali data described in the paper. Additionally the fine-tune has been carried out with the ShareGPT4V (https://sharegpt4v.github.io/) dataset.
+
+
+## Model Training
+
+### Parameters
+We train models  use low-rank adapters ([LoRA](https://arxiv.org/abs/2106.09685)) 
+with `alpha=32`  and `r=32` on the transformer layers from the language model, 
+as well as the final randomly initialized projection layer, and use a `paged_adamw_8bit` optimizer. 
+We train on an 8xA100 GPU setup with distributed data parallelism (via accelerate), a learning rate of 5e-4 with linear decay with 1% warmup steps, batch size per device is 32, in `bfloat16` format
+
+## Usage
+
+Make sure `colpali-engine` is installed from source or with a version superior to 0.3.4.
+`transformers` version must be > 4.46.1.
+
+```bash
+pip install git+https://github.com/illuin-tech/colpali
+```
+
+```python
+import torch
+from PIL import Image
+
+from colpali_engine.models import ColQwen2, ColQwen2Processor
+
+model = ColQwen2.from_pretrained(
+        "yydxlv/colqwen2-7b-v1.0",
+        torch_dtype=torch.bfloat16,
+        device_map="cuda:0",  # or "mps" if on Apple Silicon
+    ).eval()
+processor = ColQwen2Processor.from_pretrained("yydxlv/colqwen2-7b-v1.0")
+
+# Your inputs
+images = [
+    Image.new("RGB", (32, 32), color="white"),
+    Image.new("RGB", (16, 16), color="black"),
+]
+queries = [
+    "Is attention really all you need?",
+    "What is the amount of bananas farmed in Salvador?",
+]
+
+# Process the inputs
+batch_images = processor.process_images(images).to(model.device)
+batch_queries = processor.process_queries(queries).to(model.device)
+
+# Forward pass
+with torch.no_grad():
+    image_embeddings = model(**batch_images)
+    query_embeddings = model(**batch_queries)
+
+scores = processor.score_multi_vector(query_embeddings, image_embeddings)
+```
+
+
+## Limitations
 
-## Model Details
+ - **Focus**: The model primarily focuses on PDF-type documents and high-ressources languages, potentially limiting its generalization to other document types or less represented languages.
+ - **Support**: The model relies on multi-vector retreiving derived from the ColBERT late interaction mechanism, which may require engineering efforts to adapt to widely used vector retrieval frameworks that lack native multi-vector support.
 
-### Model Description
+## License
 
-ColQwen is a model based on a novel model architecture and training strategy based on Vision Language Models (VLMs) to efficiently index documents from their visual features. 
-It is a Qwen2-VL-7B extension that generates ColBERT- style multi-vector representations of text and images. 
-It was introduced in the paper ColPali: Efficient Document Retrieval with Vision Language Models and first released in this repository.
+ColQwen2's vision language backbone model (Qwen2-VL) is under `apache2.0` license.
+This fine-tuned adapter is under **CC BY NC 4.0 license**. Therefore, the use of the model is **research only** at the moment.
 
-This version is trained on 8xA800 with batch_size 32*8 for 3 epochs.
+## Citation
 
+If you use this models from this organization in your research, please cite the original paper as follows:
 
+```bibtex
+@misc{faysse2024colpaliefficientdocumentretrieval,
+  title={ColPali: Efficient Document Retrieval with Vision Language Models}, 
+  author={Manuel Faysse and Hugues Sibille and Tony Wu and Bilel Omrani and Gautier Viaud and Céline Hudelot and Pierre Colombo},
+  year={2024},
+  eprint={2407.01449},
+  archivePrefix={arXiv},
+  primaryClass={cs.IR},
+  url={https://arxiv.org/abs/2407.01449}, 
+}
+```
 
 - **Developed by:** IEIT systems