Update README.md

better readability

README.md

@@ -77,15 +77,19 @@ Any model can provide inaccurate or incomplete information, and should be used i
 
 The fastest way to get started with BLING is through direct import in transformers:
 
-    from transformers import AutoTokenizer, AutoModelForCausalLM  
-    tokenizer = AutoTokenizer.from_pretrained("llmware/bling-stable-lm-3b-4e1t-0.1")  
-    model = AutoModelForCausalLM.from_pretrained("llmware/bling-stable-lm-3b-4e1t-0.1")  
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM  
+tokenizer = AutoTokenizer.from_pretrained("llmware/bling-stable-lm-3b-4e1t-0.1")  
+model = AutoModelForCausalLM.from_pretrained("llmware/bling-stable-lm-3b-4e1t-0.1")  
+```
 
 Please refer to the generation_test .py files in the Files repository, which includes 200 samples and script to test the model.  The **generation_test_llmware_script.py** includes built-in llmware capabilities for fact-checking, as well as easy integration with document parsing and actual retrieval to swap out the test set for RAG workflow consisting of business documents.  
 
 The BLING model was fine-tuned with a simple "\<human> and \<bot> wrapper", so to get the best results, wrap inference entries as:
 
-    full_prompt = "<human>: " + my_prompt + "\n" + "<bot>:"
+```python
+full_prompt = "<human>: " + my_prompt + "\n" + "<bot>:"
+```
 
 The BLING model was fine-tuned with closed-context samples, which assume generally that the prompt consists of two sub-parts:
 
@@ -94,42 +98,44 @@ The BLING model was fine-tuned with closed-context samples, which assume general
 
 To get the best results, package "my_prompt" as follows:
 
-    my_prompt = {{text_passage}} + "\n" + {{question/instruction}}
-
+```python
+my_prompt = {{text_passage}} + "\n" + {{question/instruction}}
+```
 
 If you are using a HuggingFace generation script:
 
-    # prepare prompt packaging used in fine-tuning process
-    new_prompt = "<human>: " + entries["context"] + "\n" + entries["query"] + "\n" + "<bot>:"
-
-    inputs = tokenizer(new_prompt, return_tensors="pt")  
-    start_of_output = len(inputs.input_ids[0])
+```python
+# prepare prompt packaging used in fine-tuning process
+new_prompt = "<human>: " + entries["context"] + "\n" + entries["query"] + "\n" + "<bot>:"
 
-    #   temperature: set at 0.3 for consistency of output
-    #   max_new_tokens:  set at 100 - may prematurely stop a few of the summaries
+inputs = tokenizer(new_prompt, return_tensors="pt")  
+start_of_output = len(inputs.input_ids[0])
 
-    outputs = model.generate(
-            inputs.input_ids.to(device),
-            eos_token_id=tokenizer.eos_token_id,
-            pad_token_id=tokenizer.eos_token_id,
-            do_sample=True,
-            temperature=0.3,
-            max_new_tokens=100,
-            )
+#   temperature: set at 0.3 for consistency of output
+#   max_new_tokens:  set at 100 - may prematurely stop a few of the summaries
 
-    output_only = tokenizer.decode(outputs[0][start_of_output:],skip_special_tokens=True)  
+outputs = model.generate(
+        inputs.input_ids.to(device),
+        eos_token_id=tokenizer.eos_token_id,
+        pad_token_id=tokenizer.eos_token_id,
+        do_sample=True,
+        temperature=0.3,
+        max_new_tokens=100,
+        )
 
+output_only = tokenizer.decode(outputs[0][start_of_output:],skip_special_tokens=True)  
+```
 
 ## Citations
 
 This model has been fine-tuned on the base StableLM-3B-4E1T model from StabilityAI. For more information about this base model, please see the citation below:
-
+```
 @misc{StableLM-3B-4E1T,
       url={[https://huggingface.co/stabilityai/stablelm-3b-4e1t](https://huggingface.co/stabilityai/stablelm-3b-4e1t)},
       title={StableLM 3B 4E1T},
       author={Tow, Jonathan and Bellagente, Marco and Mahan, Dakota and Riquelme, Carlos}
 }
-
+```
 
 ## Model Card Contact