Update README.md

README.md

@@ -2,21 +2,64 @@
 tags:
 - autotrain
 - summarization
+- chat
+- T5
 language:
-- unk
+- en
 widget:
-- text: "I love AutoTrain"
+- text: >-
+    Emily: fancy a drink after work today?  Kate: sure!  Marta: Good idea! 
+    Marta: Where? When? Emily: Maybe in the Pub X at the central station at
+    5.30? Kate: I may be closer to 6, traffic on my way Marta: Fine for me.
+    Marta: See you then, Ladies! Emily: Bye! see ya :* Kate: :*
+  example_title: Meeting at the Pub
+- text: >-
+    Harry: heyyyy are you there?? Cindy: Yes dear what is it? Harry: Can you
+    call Ela and tell her i need to talk urgent please pick my call. Cindy: what
+    happened now? an other fight :O Harry: please tell her Cindy: MAN! you
+    guys... am i some kind of a messenger service here? Harry: PLEASEEEEEEEEE ?
+    Cindy: ok doing.... but thats the last time. Harry: Yes like always:P Cindy:
+    Hate you seriously man. Harry: Thank you Cindy: Done you can call her now.
+  example_title: Harry wants to call Ela
+- text: >-
+    Val: it's raining! Candy: I know, just started... Val: r we going? we will
+    be wet Candy: maybe wait a little? see if stops Val: ok. let's wait half h
+    and than see Candy: god idea, I call u then Val: great :)
+  example_title: Val and Candy
 datasets:
 - DarwinAnim8or/autotrain-data-chatsum
+- samsum
 co2_eq_emissions:
   emissions: 0.16588727515391594
+license: apache-2.0
 ---
 
-# Model Trained Using AutoTrain
+# Model Overview
+This is a fine-tune of the FLAN-T5 model from Google. This was trained on the "samsum" dataset in order to summarise chat logs. 
+There are other models sizes available in this same series:
+ * [ChatSum-Base (248M)](https://huggingface.co/DarwinAnim8or/FLAN-T5-Base-ChatSum)
+ * [ChatSum-Small (77M)](https://huggingface.co/KoalaAI/ChatSum-Small)
 
-- Problem type: Summarization
-- Model ID: 78605140974
-- CO2 Emissions (in grams): 0.1659
+## Intended Use
+
+The model is intended to be used for generating summaries of chat logs. 
+It can be employed in a wide range of applications, including but not limited to chat analysis, conversation summarization, and dialogue-based content generation.
+
+## Training Data
+
+The model has been fine-tuned on the samsum dataset, which contains conversations between two or more participants. The dataset is in English, and each conversation is associated with a summary that captures the main points of the discussion.
+
+## Limitations and Ethical Considerations
+
+As with any language model, the FLAN-T5 model has certain limitations and potential ethical considerations:
+
+1. **Limited Context Understanding**: The model's performance heavily relies on the context provided in the chat logs. It may not fully understand the nuances of the conversation, leading to occasional inaccuracies in the generated summaries.
+
+2. **Biases in Training Data**: The model's fine-tuning data (samsum dataset) may contain biases present in the original data source. This could lead to biased or unfair summaries being generated.
+
+3. **Privacy and Data Security**: If the chat logs used for summarization contain sensitive or private information, using this model may pose privacy risks, and proper data anonymization measures should be taken.
+
+4. **Responsibility in Use**: The model should be used responsibly, and the generated summaries should be carefully analyzed before making any critical decisions based on them.
 
 ## Validation Metrics
 
@@ -27,10 +70,6 @@ co2_eq_emissions:
 - RougeLsum: 45.716
 - Gen Len: 16.799
 
-## Usage
-
-You can use cURL to access this model:
+## Carbon Emissions
 
-```
-$ curl -X POST -H "Authorization: Bearer YOUR_HUGGINGFACE_API_KEY" -H "Content-Type: application/json" -d '{"inputs": "I love AutoTrain"}' https://api-inference.huggingface.co/DarwinAnim8or/autotrain-chatsum-78605140974
-```
+- CO2 Emissions (in grams): 0.1659