Update README.md

README.md

@@ -23,7 +23,6 @@ It achieves the following results on the test set:
 - Recall: 0.722477
 - F1: 0.742925
 
-
 ## Model Usage
 You can access the model with huggingface's `transformers` as follows:
 
@@ -64,6 +63,18 @@ def inference(abstract: str):
 claims = inference(abstract)  # string of claim joining with \n
 ```
 
+## Intended usage
+Takes in a statement and classifies as Claim (1) or Null (0).
+Here are some examples - 
+
+- {'text': 'We consistently found that participants selectively chose to learn that bad (good) things happened to bad (good) people (Studies 1 to 7) that is, they selectively exposed themselves to deserved outcomes.',
+ 'label': 1 (Claim)}
+- {'text': 'Members of higher status groups generalize characteristics of their ingroup to superordinate categories that serve as a frame of reference for comparisons with outgroups (ingroup projection).',
+ 'label': 0 (Null)}
+- {'text':Motivational Interviewing helped the goal progress of those participants who, at pre-screening, reported engaging in many individual pro-environmental behaviors, but the more directive approach worked better for those participants who were less ready to change.
+  'label': 1 (Claim)}
+
+
 ## Training procedure
 
 ### Training Hyperparameters
@@ -77,8 +88,6 @@ n_epochs: 6
 
 ### Training results
 
-0.038000	0.007086	0.997964	0.993499	0.995656	0.991350
-
 | Training Loss | Step | Validation Loss | Accuracy |    F1    | Precision |  Recall  |
 |:-------------:|:----:|:---------------:|:--------:|:--------:|:---------:|:--------:|
 | 0.038000      | 3996 | 0.007086        | 0.997964 | 0.993499 | 0.995656  | 0.991350 |