Update README.md

README.md

@@ -16,7 +16,7 @@ tags:
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
-This is a Llama 3 model finetuned on execution logs to be used for system anomaly detections.
+This is a Llama 3 model finetuned on execution logs to be used for a sock-shop app anomaly detections.
 
 ## Model Details
 
@@ -24,7 +24,7 @@ This is a Llama 3 model finetuned on execution logs to be used for system anomal
 
 This model was finetuned on a variety of system logs of a sock shop app. Given a log chunk of 10 messages, it generates the next log message according to normal execution.
 
-- **Developed by:** [Luís Almeida, Diego Pedroso, Lucas Pulcinelli, William Aisawa, Sarita Bruschi, Inês Dutra]
+- **Developed by:** Luís Almeida, Diego Pedroso, Lucas Pulcinelli, William Aisawa, Sarita Bruschi, Inês Dutra
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
 - **Model type:** [More Information Needed]
@@ -36,18 +36,19 @@ This model was finetuned on a variety of system logs of a sock shop app. Given a
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [https://github.com/lasdpc-icmc/maia]
+- **Repository:** https://github.com/lasdpc-icmc/maia
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
+Since the model was finetuned on execution logs of the sock-shop app, it is intended to be used to generate logs of said app. To adapt it to another system, it should be 
+finetuned on a sample of execution logs of the new system. 
 
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+Direct plugin to the sock-shop app.
 
 [More Information Needed]
 
@@ -59,27 +60,18 @@ This model was finetuned on a variety of system logs of a sock shop app. Given a
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The usage of this model on execution logs that it hasn't been finetuned on may yield bad results.
 
 ### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+We recommend users to finetune this model on logs of their app before they use it.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
-
-[More Information Needed]
+Please refer to https://github.com/lasdpc-icmc/maia/apps/llm for the code files that were developed for this model. The file "eval_llm.py" provides code to detect system
+anomalies.
 
 ## Training Details