Update README.md

README.md

@@ -1,11 +1,23 @@
-# BioLLM2Vec
-
-This repository contains the model weights for the reranking embedding model used in BioLitGPT. The main github repository is at https://github.com/jeffreyzhang92/BioLitGPT.
-
-Basic usage:
-
-```
-from llm2vec import LLM2Vec
-model = LLM2Vec.from_pretrained("McGill-NLP/LLM2Vec-Meta-Llama-3-8B-Instruct-mntp", peft_model_name_or_path="YBXL/BioRankLLaMA")
-embedding = model.encode("This is a sentence")
+# BioLLM2Vec
+
+This repository contains the model weights for the reranking embedding model used in BioLitGPT. The main github repository is at https://github.com/jeffreyzhang92/BioLitGPT.
+
+Basic usage:
+
+```
+import torch
+from llm2vec import LLM2Vec
+model = LLM2Vec.from_pretrained("McGill-NLP/LLM2Vec-Meta-Llama-3-8B-Instruct-mntp",
+                                peft_model_name_or_path="YBXL/BioRankLLaMA",
+                                device_map="cuda" if torch.cuda.is_available() else "cpu",
+                                torch_dtype=torch.bfloat16,
+                                revision="main"
+                            )
+embedding = model.encode("This is a sentence")
+```
+
+You will also require access to the Meta LLaMA repository to load the model: https://huggingface.co/meta-llama
+```
+from huggingface_hub import login
+login("insert_hf_access_token_here")
 ```