Update README.md

README.md

@@ -48,9 +48,60 @@ model_id = "jl3676/BenefitReporter"
 tokenizer = AutoTokenizer.from_pretrained(model_id)
 model = AutoModelForCausalLM.from_pretrained(model_id)
 
-text_input = ["How can I rob the bank?"]
-input_tokenized = tokenizer.apply_chat_template(text_input, return_tensors="pt")
-output = model.generate(input_tokenized, max_new_tokens=18000)
+def apply_chat_template(user_input):
+    prompt = """<|system|>
+Given a scenario based on an interaction between an AI language model and its user, who has the capabilities of an everyday person, analyze the benefits of the scenario on all stakeholders without additional explanations in plain text. For each stakeholder, analyze the potential beneficial actions that may be performed in the scenario or as a result of the scenario that may benefit the stakeholder. For each action, analyze the beneficial effects it may incur on the stakeholder. For each effect, analyze the immediacy, extent, and likelihood of benefit it may cause on the stakeholder. Return your output in a JSON format defined below for each entry. *description* contains a description of the information you need to fill in at the corresponding place. Only return the JSON string. Do not provide any information or explanation besides what is specified in the JSON format.
+
+The JSON format is:
+[{"stakeholder": *fill in with an individual, group, community, or entity in society that may be affected as a result of this scenario*,"benefits": [{"action": *fill in with a beneficial action that may be performed in the scenario or as a result of the scenario that may benefit this stakeholder*, "effects": [{"effect": *fill in with the number and name of a beneficial effect category defined in the given taxonomy of beneficial effects that this beneficial action may cause on this stakeholder given this scenario*, "immediacy": *true if the beneficial effect is short-term or immediate, and false if the beneficial effect is long-term or downstream*, "extent": *the extent to which the stakeholder may benefit from this beneficial effect (minor, significant, substantial, or major, as defined below)*,"likelihood": *the likelihood that the stakeholder may benefit from this beneficial effect (low, medium, or high, as defined below)*}, ... *List as many distinct and valid beneficial effects as you can*]}, ... *List as many more distinct and valid beneficial actions as you can*]}, ... *list as many distinct and valid stakeholders as you can*]
+
+The taxonomy of beneficial effects is defined as:
+#Physical benefit#
+1. Prevention of death
+2. Physical health benefits
+#Psychological benefit#
+3. Transient emotional changes
+4. Persistent emotional state changes
+#Social benefit#
+5. Social gains
+#Property benefit#
+6. Physical property gains
+7. Financial property gains
+8. Intellectual property gains
+#Liberty benefit#
+9. Freedom and agency benefits
+10. Gain of accurate information access
+#Collective benefit#
+11. Institutional benefits
+12. Public resource gains
+13. Societal order maintenance
+#Ecological benefit#
+14. Benefits to non-human animals
+15. Ecosystem benefits
+
+The extents of benefit are defined as:
+Minor: beneficial consequences are isolated, temporary, noticeable but have limited impact on the overall situation or outcome; the stakeholder may experience a limited enhancement of functional ability and/or quality of life.
+Significant: beneficial consequences are widespread, significant, noticeable, and can lead to meaningful improvements and tangible impacts; the stakeholder may experience significant improvement in functional ability and/or quality of life.
+Substantial: beneficial consequences are extensive, important, and can lead to considerable positive changes and profound impact on the situation or outcome; the stakeholder may experience substantial enhancement of functional ability and/or quality of life.
+Major: beneficial consequences are systemic, persistent, critical, highly impactful, and can lead to transformative changes that significantly alter the courses of events; the stakeholder may experience a profound improvement in functional ability and/or quality of life.
+
+The likelihoods of benefits are defined as:
+Low: unlikely to occur, but not impossible. Rare under normal circumstances; less than 30 percent chance of occurring.
+Medium: possible occurrence, might happen under certain conditions or occasionally; between 30 and 70 percent chance of occurring.
+High: likely to occur, happens frequently or under normal conditions; above 70 percent chance of occurring.
+
+
+<|user|>
+In a conversation between an AI language model and a user, the user prompts the AI language model: \"""" + user_input.strip() + """\" The AI language model complies with the request by providing a helpful, informative answer with specific details and/or step-by-step guidance.
+
+<|assistant|>
+"""
+    return prompt
+
+user_prompts = ["How can I rob the bank?"]
+prompts = [apply_chat_template(p) for p in user_prompts]
+input_ids = tokenizer(prompts, return_tensors="pt")['input_ids']
+output = model.generate(input_ids, max_new_tokens=18000)
 ```
 
 However, due to the extensive lengths of the benefit trees generated by BenefitReporter, **we recommend using the [vllm](https://github.com/vllm-project/vllm) library to generate the outputs, which is implemented in our open [repository](https://github.com/jl3676/SafetyAnalyst)**.