Update README.md

README.md

@@ -1,3 +1,5 @@
+# Model Loading
+
 The model can be loaded in the following way:
 ```
 from transformers import AutoTokenizer, AutoModelForCausalLM
@@ -7,7 +9,18 @@ tokenizer = AutoTokenizer.from_pretrained("philippelaban/keep_it_simple")
 kis_model = AutoModelForCausalLM.from_pretrained("philippelaban/keep_it_simple")
 ```
 
-And then used by first inputting a paragraph for simplification, followed by a `bos_token` to indicate to the model to start simplifying:
+# Example use
+
+And then used by first inputting a paragraph for simplification, followed by a `bos_token` to indicate to the model to start simplifying.
+Imagine we want to simplify the following paragraph:
+```
+A small capsule containing asteroid soil samples that was dropped from 136,700 miles in space
+by Japan's Hayabusa2 spacecraft landed as planned in the Australian Outback on December 6.
+The extremely high precision required to carry out the mission thrilled many in Japan,
+who said they took pride in its success.
+```
+
+The following code can be run:
 ```
 paragraph = """A small capsule containing asteroid soil samples that was dropped from 136,700 miles in space by Japan's Hayabusa2 spacecraft landed as planned in the Australian Outback on December 6. The extremely high precision required to carry out the mission thrilled many in Japan, who said they took pride in its success."""
 
@@ -25,6 +38,8 @@ for o in output:
     print(o)
 ```
 
+# Example output
+
 When run, an output similar to the following should be obtained:
 
 A small capsule containing samples of asteroid soil that was dropped from 136,700 miles, Japan's Hayabusa2 space probe, landed as planned on December 6. The mission was extremely precise, said many in Japan, and they took pride in its success.
@@ -33,4 +48,9 @@ A small capsule containing samples of asteroid soil that was dropped from 136,70
 
 A small capsule containing soil samples that was dropped from 136,700 miles, Japan's Hayabusa2 space probe, landed as planned on December 6. The mission was designed to test the performance of the country's space fleet, which many said took pride in its success.
 
-A small capsule containing soil samples that was dropped from 136,700 miles in space by Japan's Hayabusa2 probe was followed by a landing on the Outback. The precise timing of the mission thrilled many in Japan, who said they took pride in its success.
+A small capsule containing soil samples that was dropped from 136,700 miles in space by Japan's Hayabusa2 probe was followed by a landing on the Outback. The precise timing of the mission thrilled many in Japan, who said they took pride in its success.
+
+# Github repo
+
+You can access more information, access to the scoring function, the training script, or an example training log on the Github repo:
+https://github.com/tingofurro/keep_it_simple