Update README.md

README.md

@@ -1,14 +1,41 @@
 ---
-base_model: []
+base_model: mistralai/Mistral-7B-v0.1
 library_name: transformers
 tags:
 - mergekit
 - merge
-
+- medical
+license: apache-2.0
 ---
-# merge
 
-This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
+<img src="https://huggingface.co/cmcmaster/il_7b/resolve/main/il_7b_logo.png" alt="IL-7B Logo" width="400" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+
+IL-7B (Immuno-LLM 7 Billion) is a 7 billion parameter LLM trained and merged from Mistral-7B for the domain of clinical rheumatology and immunology.
+It is a merge of 2 models trained with the same recipe and data, initialized from 2 different weights: the original Mistral-7B weights and the BioMistral-7B weights.
+Merging was done using [mergekit](https://github.com/cg123/mergekit).
+
+Note: IL-7B is an AI tool developed for research and general interest in rheumatology and autoimmune diseases. It has not been validated in and should not be used for direct clinical decision making.
+
+## Intended Use
+
+IL-7B uses the same prompt format as Zephyr from HF.
+```python
+import torch
+from transformers import pipeline
+pipe = pipeline("text-generation", model="cmcmaster/il_7b, torch_dtype=torch.bfloat16, device_map="auto")
+messages = [
+    {"role": "user", "content": "How many helicopters can a human eat in one sitting?"},
+]
+prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+outputs = pipe(prompt, max_new_tokens=1024, do_sample=True, temperature=0.7)
+print(outputs[0]["generated_text"])
+# <|user|>
+# A patient with longstanding psoriasis presents with pain in the hands, particularly first thing in the morning, associated with stiffness. You notice swelling of several metacarpophalangeal joints and both wrists. ESR is 38, CRP is 63 and the rheumatoid factor is weakly positive (31). What is the most likely diagnosis and why?</s>
+# <|assistant|>
+# The most likely diagnosis is psoriatic arthritis (PsA). The patient has a longstanding history of psoriasis, which is a skin condition characterized by red, scaly patches. The symptoms of pain, stiffness, swelling of the metacarpophalangeal joints, and both wrists are common in psoriatic arthritis. The elevated ESR and CRP levels indicate inflammation, which is also consistent with psoriatic arthritis. The weakly positive rheumatoid factor could be due to the psoriatic arthritis, as it may sometimes occur in patients with this condition.
+```
+
 
 ## Merge Details
 ### Merge Method
@@ -17,10 +44,9 @@ This model was merged using the SLERP merge method.
 
 ### Models Merged
 
-The following models were included in the merge:
-* /mnt/hdd/projects/rheum_llm/alignment-handbook/biorheumistral-sft-merged
-* /mnt/hdd/projects/rheum_llm/alignment-handbook/rheumistral-sft-merged-final
-
+The merge was made from two unreleased models:
+- rheumistral-sft was trained from the original mistral checkpoint in two stages: 1) "continued pretraining" on a large, curated dataset of rheumatology and immunology texts; 2) supervised finetuning on a combination of synthetic and human generated QA pairs and chat logs
+- biorheumistral-sft was trained the same way as rheumistral-sft, only it started from the [BioMistral-7B](https://huggingface.co/BioMistral/BioMistral-7B) checkpoint.
 ### Configuration
 
 The following YAML configuration was used to produce this model:
@@ -28,9 +54,9 @@ The following YAML configuration was used to produce this model:
 ```yaml
 slices:
   - sources:
-      - model: /mnt/hdd/projects/rheum_llm/alignment-handbook/rheumistral-sft-merged-final
+      - model: rheumistral-sft
         layer_range: [0, 32]
-      - model: /mnt/hdd/projects/rheum_llm/alignment-handbook/biorheumistral-sft-merged
+      - model: biorheumistral-sft
         layer_range: [0, 32]
 merge_method: slerp
 base_model: /mnt/hdd/projects/rheum_llm/alignment-handbook/rheumistral-sft-merged-final
@@ -43,4 +69,4 @@ parameters:
     - value: 0.5
 dtype: bfloat16
 
-```
+```