justtherightsize
/

zephyr-7b-sft-full124

Text Generation

Safetensors

English

conversational

Eval Results

Model card Files Files and versions Community

justtherightsize commited on Sep 20

Commit

d21b521

•

1 Parent(s): f3a81d3

Upload README.md

Browse files

Files changed (1) hide show

README.md +81 -186

README.md CHANGED Viewed

@@ -1,199 +1,94 @@
 ---
-library_name: transformers
-tags: []
----
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **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. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### 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]
-### 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.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: mit
+datasets:
+  - facebook/empathetic_dialogues
+language:
+  - en
+base_model: alignment-handbook/zephyr-7b-sft-full
+widget:
+  - example_title: Pirate!
+    messages:
+      - role: system
+        content: You are a friendly assistant, who provides empathetic responses to the user. The input contains previous turn of the dialog, where each utterance is prefaced with tags <|user>, or <|assistant|>. Be empathetic and precise. Make sure to give responses that make the dialogue flow. Avoid repeating the prompt. Please respond creatively and expressively to make the responses longer. You can offer advice.
+      - role: user
+        content: Yeah about 10 years ago I had a horrifying experience. It was 100% their fault but they hit the water barrels and survived. They had no injuries but they almost ran me off the road.
+      - role: assistant
+        content: Did you suffer any injuries?
+      - role: user
+        content: No I wasn't hit. It turned out they were drunk. I felt guilty but realized it was his fault.
+    output:
+      text: >-
+        That's good that you didn't get hurt. I hope they got in trouble for driving drunk.
+pipeline_tag: text-generation
+model-index:
+  - name: justtherightsize/zephyr-7b-sft-full124
+    results:
+      - task:
+          type: text-generation
+          name: Text Generation
+        dataset:
+          name: Open LLM Leaderboard
+          type: various
+          config: various
+          split: various
+          args:
+            num_few_shot: 5
+        metrics:
+          - type: acc
+            name: accuracy
+            value: 0.2701
+        source:
+          name: Open LLM Leaderboard
+          url: >-
+            https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard
+      - task:
+          type: text-generation
+          name: Text Generation
+        dataset:
+          name: MMLU (5-Shot)
+          type: cais/mmlu
+          config: all
+          split: test
+          args:
+            num_few_shot: 5
+        metrics:
+          - type: acc
+            name: accuracy
+            value: 58.50
+        source:
+          name: MMLU
+          url: >-
+            https://github.com/huggingface/lm-evaluation-harness.git
+---
+# Model Card for zephyr-7b-sft-full124
+This model paricipated in multi-turn dialogues and responses empathetically.
+## Model Description
+ We propose a data-driven solution for Empathetic Response Generation with LLMs: aligning LLMs via preference optimization algorithms. First, we build a preference dataset using the benchmark dataset EmpatheticDialogues (Rashkin et al., 2019). It contains short multi-turn human-to-human dialogues grounded by emotion labels. We leverage this emotion grounding to sample dialog completions labeled with polar opposite emotions using Plutchik’s wheel (Plutchik, 2001) such that each prompt is paired with preferred and non-preferred completions. We then fine-tune a foundational LLM using Direct Preference Optimization (DPO) (Rafailov et al., 2024) to generate responses aligned with the preferred candidate response.
+- **Developed by:** TBA
+- **Model type:** Autoregressive Encoder-Decoder
+- **Language(s):** en
+- **Finetuned from:** alignment-handbook/zephyr-7b-sft-full
+## Sources
+- **Repository:** <https://github.com/justtherightsize/empo>
+- **(*non-anonymized*) Paper preprint:** <https://arxiv.org/abs/2406.19071>
+## Usage
+TODO
+## Out-of-Scope Usage
+Note that fine-tuning on the EmpatheticDialogues caused some specialization.
+## Training
+TODO
+## Cite
+TBA, now please cite the **non-anonymized** [preprint](https://arxiv.org/abs/2305.15017)