nkwbtb
/

flan-t5-11b-SummaCoz

@@ -1,172 +1,63 @@
 ---
 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]
@@ -175,27 +66,3 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 **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]

 ---
 library_name: transformers
+tags:
+- factual
+- consistency
+- hallucination
+license: apache-2.0
+datasets:
+- nkwbtb/SummaCoz
+language:
+- en
+base_model:
+- nkwbtb/flan-t5-xxl-bf16
+pipeline_tag: text2text-generation
 ---
+# SummaCoz LoRA Adapter for flan-t5-xxl
 <!-- Provide a quick summary of what the model is/does. -->
+The model provides summarization factual consistency classificaiton and explanations.
 ## Model Details
+The model for the paper [SummaCoz: A Dataset for Improving the Interpretability of Factual Consistency Detection for Summarization](https://openreview.net/forum?id=1zJrDjKTWg)
+Dataset: [`nkwbtb/SummaCoz`](https://huggingface.co/datasets/nkwbtb/SummaCoz)
+## Model Usage
+```python
+from transformers import AutoModelForSeq2SeqLM, AutoTokenizer, pipeline
+tokenizer = AutoTokenizer.from_pretrained("google/flan-t5-xxl")
+model = AutoModelForSeq2SeqLM.from_pretrained("nkwbtb/flan-t5-11b-SummaCoz",
+                                              torch_dtype="auto",
+                                              device_map="auto")
+pipe = pipeline("text2text-generation",
+                model=model,
+                tokenizer=tokenizer)
+PROMPT = """Is the hypothesis true based on the premise? Give your explanation afterwards.
+Premise:
+{article}
+Hypothesis:
+{summary}
+"""
+article = "Goldfish are being caught weighing up to 2kg and koi carp up to 8kg and one metre in length."
+summary = "Goldfish are being caught weighing up to 8kg and one metre in length."
+print(pipe(PROMPT.format(article=article, summary=summary),
+           do_sample=False,
+           max_new_tokens=512))
+"""[{'generated_text': '\
+No, the hypothesis is not true. \
+- The hypothesis states that goldfish are being caught weighing up to 8kg and one metre in length. \
+- However, the premise states that goldfish are being caught weighing up to 2kg and koi carp up to 8kg and one metre in length. \
+- The difference between the two is that the koi carp is weighing 8kg and the goldfish is weighing 2kg.'}]"""
+```
 ## Citation [optional]
 **BibTeX:**
 [More Information Needed]