PEFT
Safetensors
blip2-opt-2.7b-hm / README.md
omgwenxx's picture
Add model description and demo code
b9ce6f4 verified
---
base_model: Salesforce/blip2-opt-2.7b
library_name: peft
---
# Model Card for Model ID
This is an adapter for the Salesforce BLIP2 2.7B model (more information on the model [here](https://huggingface.co/Salesforce/blip2-opt-2.7b)). It was fine-tuned for generating product descriptions based on images using the [H&M dataset](https://www.kaggle.com/competitions/h-and-m-personalized-fashion-recommendations) from the kaggle challenge 2022.
## How to Get Started with the Model
Use the code below to get started with the model. Make sure to replace the path with a local path to an image.
```python
from transformers import Blip2Processor, Blip2ForConditionalGeneration
from PIL import Image
import torch
torch_dtype = torch.bfloat16
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
base_checkpoint = "Salesforce/blip2-opt-2.7b"
base_model = Blip2ForConditionalGeneration.from_pretrained(base_checkpoint, torch_dtype=torch_dtype)
adapter_checkpoint = "CDL-RecSys/blip2-opt-2.7b-hm"
model = PeftModel.from_pretrained(base_model, model_id=adapter_checkpoint)
processor = Blip2Processor.from_pretrained(base_checkpoint)
tokenizer = processor.tokenizer
image = Image.open("path/to/your/image.jpg")
inputs = processor(image, return_tensors="pt").to(device, torch_dtype)
generated_ids = model.generate(**inputs, max_length=max_length)
generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)
generated_text
```
## 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]
### Framework versions
- PEFT 0.12.0