hivaze
/

AAQG-QA-QG-FRED-T5-large

@@ -1,201 +1,100 @@
 ---
 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]

 ---
+language:
+- ru
+license: apache-2.0
 library_name: transformers
+datasets:
+- hivaze/ru-AAQG-QA-QG
+pipeline_tag: text2text-generation
 ---
+## Description
+This is **ai-forever/FRED-T5-large** model trained on **Question-Answering**, **Question-Generation** and **Answer-Aware Question Generation** tasks on russian dataset (**hivaze/ru-AAQG-QA-QG**)
+### Prompts
+```python
+AAQG_PROMPT = "Сгенерируй вопрос по тексту, используя известный ответ. Текст: '{context}'. Ответ: '{answer}'."
+QG_PROMPT = "Сгенерируй вопрос по тексту. Текст: '{context}'."
+QA_PROMPT = "Сгенерируй ответ на вопрос по тексту. Текст: '{context}'. Вопрос: '{question}'."
+```
+### Examples and code
+```python
+from transformers import AutoTokenizer, T5ForConditionalGeneration
+from functools import partial
+saved_checkpoint = 'hivaze/AAQG-QA-QG-FRED-T5-large'
+tokenizer = AutoTokenizer.from_pretrained(saved_checkpoint)
+model = T5ForConditionalGeneration.from_pretrained(saved_checkpoint).cuda()
+def generate_text(prompt, tokenizer, model, n=1, temperature=0.8, num_beams=3):
+  encoded_input = tokenizer.encode_plus(prompt, return_tensors='pt')
+  encoded_input = {k: v.to(model.device) for k, v in encoded_input.items()}
+  resulted_tokens = model.generate(**encoded_input,
+                                   max_new_tokens=64,
+                                   do_sample=True,
+                                   num_beams=num_beams,
+                                   num_return_sequences=n,
+                                   temperature=temperature,
+                                   top_p=0.9,
+                                   top_k=50)
+  resulted_texts = tokenizer.batch_decode(resulted_tokens, skip_special_tokens=True)
+  return resulted_texts
+generate_text = partial(generate_text, tokenizer=tokenizer, model=model)
+test_context = "Путешественник Федор Конюхов и пилот Игорь Потапкин установили мировой рекорд высоты полета на паралёте, поднявшись на высоту 4728 метров — сайт Конюхова"
+```
+#### AAQG
+```python
+generate_text(AAQG_PROMPT.format(
+  context=test_context,
+  answer='на паралёте'
+), n=1)
+```
+> "На чём установили мировой рекорд высоты полета Федор Конюхов и пилот Игорь Потапкин?"
+```python
+generate_text(AAQG_PROMPT.format(
+  context=test_context,
+  answer='рекорд высоты полета'
+), n=1)
+```
+> "Что установили Конюхов и Потапкин?"
+#### QA
+```python
+generate_text(QA_PROMPT.format(
+  context=test_context,
+  question='Что установили путешественник Федор Конюхов и пилот Игорь Потапкин?'
+), n=1)
+```
+> "мировой рекорд высоты полета на паралёте, поднявшись на высоту 4728 метров — сайт Конюхова"
+#### QG
+```python
+generate_text(QG_PROMPT.format(context=test_context), n=1)
+```
+> "Кто установил мировой рекорд высоты полета на паралёте, поднявшись на высоту 4728 метров?"
+## Metrics
+| Step | Training Loss | Validation Loss | Sbleu | Chr F | Rouge1 | Rouge2 | Rougel |
+|------|---------------|-----------------|-------|-------|--------|--------|--------|
+| 500  | 1.183100      | 1.188049        | 40.114700 | 62.147000 | 0.104600 | 0.034500 | 0.104300 |
+| 1000 | 1.193000      | 1.125300        | 40.722300 | 62.661400 | 0.104700 | 0.033900 | 0.104300 |
+| 1500 | 1.114300      | 1.097496        | 41.416600 | 63.060300 | 0.106100 | 0.033800 | 0.105800 |
+| 2000 | 1.081300      | 1.080900        | 41.600200 | 63.260500 | 0.106200 | 0.033700 | 0.105900 |
+| 2500 | 1.076900      | 1.070221        | 41.722300 | 63.315300 | 0.106300 | 0.034100 | 0.106000 |
+| 3000 | 1.125600      | 1.062671        | 41.744500 | 63.409400 | 0.106400 | 0.034200 | 0.106200 |
+## Authors
+- Sergei Bratchikov (https://t.me/nlpwanderer)