Instructions to use obss/mt5-base-3task-highlight-combined3 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use obss/mt5-base-3task-highlight-combined3 with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="obss/mt5-base-3task-highlight-combined3")

# Load model directly
from transformers import AutoTokenizer, AutoModelForSeq2SeqLM

tokenizer = AutoTokenizer.from_pretrained("obss/mt5-base-3task-highlight-combined3")
model = AutoModelForSeq2SeqLM.from_pretrained("obss/mt5-base-3task-highlight-combined3")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use obss/mt5-base-3task-highlight-combined3 with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "obss/mt5-base-3task-highlight-combined3"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "obss/mt5-base-3task-highlight-combined3",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/obss/mt5-base-3task-highlight-combined3

SGLang

How to use obss/mt5-base-3task-highlight-combined3 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 "obss/mt5-base-3task-highlight-combined3" \
    --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": "obss/mt5-base-3task-highlight-combined3",
		"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 "obss/mt5-base-3task-highlight-combined3" \
        --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": "obss/mt5-base-3task-highlight-combined3",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use obss/mt5-base-3task-highlight-combined3 with Docker Model Runner:
```
docker model run hf.co/obss/mt5-base-3task-highlight-combined3
```

fcakyon commited on Dec 14, 2022

Commit

5ee3af7

1 Parent(s): 3a56e22

update citation

Browse files

Files changed (1) hide show

README.md +8 -6

README.md CHANGED Viewed

@@ -34,11 +34,13 @@ generation_api = GenerationAPI('mt5-base-3task-highlight-combined3')
 ##  Citation 📜
 ```
-@article{akyon2021automated,
-  title={Automated question generation and question answering from Turkish texts using text-to-text transformers},
-  author={Akyon, Fatih Cagatay and Cavusoglu, Devrim and Cengiz, Cemil and Altinuc, Sinan Onur and Temizel, Alptekin},
-  journal={arXiv preprint arXiv:2111.06476},
-  year={2021}
 }
 ```
@@ -48,7 +50,7 @@ generation_api = GenerationAPI('mt5-base-3task-highlight-combined3')
 **Downstream-task:** Extractive QA/QG, Answer Extraction
 **Training data:** TQuADv2-train, TQuADv2-val, XQuAD.tr
 **Code:**  https://github.com/obss/turkish-question-generation
-**Paper:**  https://arxiv.org/abs/2111.06476
 ## Hyperparameters
 ```

 ##  Citation 📜
 ```
+@article{akyon2022questgen,
+    author = {Akyon, Fatih Cagatay and Cavusoglu, Ali Devrim Ekin and Cengiz, Cemil and Altinuc, Sinan Onur and Temizel, Alptekin},
+    doi = {10.3906/elk-1300-0632.3914},
+    journal = {Turkish Journal of Electrical Engineering and Computer Sciences},
+    title = {{Automated question generation and question answering from Turkish texts}},
+    url = {https://journals.tubitak.gov.tr/elektrik/vol30/iss5/17/},
+    year = {2022}
 }
 ```
 **Downstream-task:** Extractive QA/QG, Answer Extraction
 **Training data:** TQuADv2-train, TQuADv2-val, XQuAD.tr
 **Code:**  https://github.com/obss/turkish-question-generation
+**Paper:**  https://journals.tubitak.gov.tr/elektrik/vol30/iss5/17/
 ## Hyperparameters
 ```