Instructions to use SimuIation/CDM_Digital_Navigator with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use SimuIation/CDM_Digital_Navigator with Transformers:

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

pipe = pipeline("text-generation", model="SimuIation/CDM_Digital_Navigator")

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("SimuIation/CDM_Digital_Navigator")
model = AutoModelForCausalLM.from_pretrained("SimuIation/CDM_Digital_Navigator")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use SimuIation/CDM_Digital_Navigator with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/SimuIation/CDM_Digital_Navigator

SGLang

How to use SimuIation/CDM_Digital_Navigator 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 "SimuIation/CDM_Digital_Navigator" \
    --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": "SimuIation/CDM_Digital_Navigator",
		"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 "SimuIation/CDM_Digital_Navigator" \
        --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": "SimuIation/CDM_Digital_Navigator",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use SimuIation/CDM_Digital_Navigator with Docker Model Runner:
```
docker model run hf.co/SimuIation/CDM_Digital_Navigator
```

SimuIation commited on Jul 9, 2024

Commit

6844a22

verified ·

1 Parent(s): 786434d

Update README.md

Browse files

Files changed (1) hide show

README.md +4 -19

README.md CHANGED Viewed

@@ -19,7 +19,7 @@ This modelcard aims to be a base template for new models. It has been generated
 ### Model Description
-The Digital Navigator model is designed to assist users by generating natural language responses to input queries. It is a fine-tuned GPT-2 model, customized for providing  assistanse to visitors of my university's website: https://cdm.uowm.gr/en/index/.
 - **Developed by:** Papagiannakis Panagiotis
 - **Model type:** GPT-2 (Generative Pre-trained Transformer 2)
@@ -31,11 +31,7 @@ The Digital Navigator model is designed to assist users by generating natural la
 ### Direct Use
-The Digital Navigator model can be directly used for generating conversational responses in English. It is intended for use in chatbots, virtual assistants, and other applications requiring natural language understanding and generation.
-1. Conversational AI
-2. Customer Support
-3. Virtual Assistance
 ### Out-of-Scope Use
@@ -77,20 +73,9 @@ The model was trained using standard procedures for fine-tuning GPT-2 models.
 - Block Size: 128
-## Evaluation
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
 #### Metrics
-The model was evaluated using metrics like BLEU score for language quality, accuracy for factual correctness,
 ### Results
@@ -110,7 +95,7 @@ Due to the high complexity and small variety of the data:
 ## Model Examination
-- **Hardware Type:** [More Information Needed]
 - **Hours used:** 18 minutes and 47 seconds
 - **Cloud Provider:** Google Collab

 ### Model Description
+The Digital Navigator model is designed to assist users by generating natural language responses to input queries. It is a fine-tuned GPT-2 model, customized for providing assistanse to the visitors of Communication and Digital Media Department's website: https://cdm.uowm.gr/en/index/.
 - **Developed by:** Papagiannakis Panagiotis
 - **Model type:** GPT-2 (Generative Pre-trained Transformer 2)
 ### Direct Use
+Users do not have much of a choice but only use it for experimental and educational purposes, since the model was fine-tuned for specific answers and question related to the Department of Communication and Digital Media website: https://cdm.uowm.gr/en/index/.
 ### Out-of-Scope Use
 - Block Size: 128
 #### Metrics
+The model was evaluated using metrics like BLEU score for language quality, accuracy for factual correctness, precision for the accuracy of positive predictions, recall for the ability to find all relevant instances, and F1 score to balance precision and recall.
 ### Results
 ## Model Examination
+- **Hardware Type:** NVIDIA T4
 - **Hours used:** 18 minutes and 47 seconds
 - **Cloud Provider:** Google Collab