Text Generation
Transformers
PyTorch
Russian
mt5
text2text-generation
question generation
Eval Results (legacy)
Instructions to use vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg")# Load model directly from transformers import AutoTokenizer, AutoModelForSeq2SeqLM tokenizer = AutoTokenizer.from_pretrained("vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg") model = AutoModelForSeq2SeqLM.from_pretrained("vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg", device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg
- SGLang
How to use vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg with Docker Model Runner:
docker model run hf.co/vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg
metadata
license: cc-by-4.0
metrics:
- bleu4
- meteor
- rouge-l
- bertscore
- moverscore
language: ru
datasets:
- lmqg/qg_ruquad
pipeline_tag: text2text-generation
tags:
- question generation
widget:
- text: >-
Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев,
поначалу априорно выдвинув идею о температуре, при которой высота мениска
будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.
example_title: Question Generation Example 1
- text: >-
Однако, франкоязычный <hl> Квебек <hl> практически никогда не включается в
состав Латинской Америки.
example_title: Question Generation Example 2
- text: >-
Классическим примером международного синдиката XX века была группа
компаний <hl> Де Бирс <hl> , которая в 1980-е годы контролировала до 90 %
мировой торговли алмазами.
example_title: Question Generation Example 3
model-index:
- name: vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg
results:
- task:
name: Text2text Generation
type: text2text-generation
dataset:
name: lmqg/qg_ruquad
type: default
args: default
metrics:
- name: BLEU4 (Question Generation)
type: bleu4_question_generation
value: 18.8
- name: ROUGE-L (Question Generation)
type: rouge_l_question_generation
value: 34.64
- name: METEOR (Question Generation)
type: meteor_question_generation
value: 30.03
- name: BERTScore (Question Generation)
type: bertscore_question_generation
value: 86.61
- name: MoverScore (Question Generation)
type: moverscore_question_generation
value: 65.62
Model Card of vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg
This model is fine-tuned version of vocabtrimmer/mt5-small-trimmed-ru-10000 for question generation task on the lmqg/qg_ruquad (dataset_name: default) via lmqg.
Overview
- Language model: vocabtrimmer/mt5-small-trimmed-ru-10000
- Language: ru
- Training data: lmqg/qg_ruquad (default)
- Online Demo: https://autoqg.net/
- Repository: https://github.com/asahi417/lm-question-generation
- Paper: https://arxiv.org/abs/2210.03992
Usage
- With
lmqg
from lmqg import TransformersQG
# initialize model
model = TransformersQG(language="ru", model="vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg")
# model prediction
questions = model.generate_q(list_context="Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, в мае 1860 года провёл серию опытов.", list_answer="в мае 1860 года")
- With
transformers
from transformers import pipeline
pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-ru-10000-ruquad-qg")
output = pipe("Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.")
Evaluation
- Metric (Question Generation): raw metric file
| Score | Type | Dataset | |
|---|---|---|---|
| BERTScore | 86.61 | default | lmqg/qg_ruquad |
| Bleu_1 | 34.72 | default | lmqg/qg_ruquad |
| Bleu_2 | 27.84 | default | lmqg/qg_ruquad |
| Bleu_3 | 22.74 | default | lmqg/qg_ruquad |
| Bleu_4 | 18.8 | default | lmqg/qg_ruquad |
| METEOR | 30.03 | default | lmqg/qg_ruquad |
| MoverScore | 65.62 | default | lmqg/qg_ruquad |
| ROUGE_L | 34.64 | default | lmqg/qg_ruquad |
Training hyperparameters
The following hyperparameters were used during fine-tuning:
- dataset_path: lmqg/qg_ruquad
- dataset_name: default
- input_types: paragraph_answer
- output_types: question
- prefix_types: None
- model: vocabtrimmer/mt5-small-trimmed-ru-10000
- max_length: 512
- max_length_output: 32
- epoch: 15
- batch: 16
- lr: 0.001
- fp16: False
- random_seed: 1
- gradient_accumulation_steps: 4
- label_smoothing: 0.15
The full configuration can be found at fine-tuning config file.
Citation
@inproceedings{ushio-etal-2022-generative,
title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration",
author = "Ushio, Asahi and
Alva-Manchego, Fernando and
Camacho-Collados, Jose",
booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing",
month = dec,
year = "2022",
address = "Abu Dhabi, U.A.E.",
publisher = "Association for Computational Linguistics",
}