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

Libraries

How to use AgentPublic/Faust with Transformers:

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

pipe = pipeline("text-generation", model="AgentPublic/Faust")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("AgentPublic/Faust")
model = AutoModelForCausalLM.from_pretrained("AgentPublic/Faust", device_map="auto")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use AgentPublic/Faust with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "AgentPublic/Faust"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "AgentPublic/Faust",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/AgentPublic/Faust

SGLang

How to use AgentPublic/Faust 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 "AgentPublic/Faust" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "AgentPublic/Faust",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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 "AgentPublic/Faust" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "AgentPublic/Faust",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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

Pclanglais commited on Nov 6, 2023

Commit

260962f

1 Parent(s): 4c14559

Create README.md

Browse files

Files changed (1) hide show

README.md +37 -0

README.md ADDED Viewed

	@@ -0,0 +1,37 @@

+---
+license: apache-2.0
+language:
+- fr
+library_name: transformers
+pipeline_tag: text-generation
+---
+French chat model based on Mistral-Hermes and trained on answers from servicespublics.fr and synthetic questions.
+The syntax is based on chatml and should be used this way.
+> <|im_start|>system\nTu es Félix, le chatbot des services publics français. Tu dois apporter une réponse courtoise à la question qui t'es posée en utilisant un language précis et administratif<|im_end|>\n<|im_start|>user\n[Question]<|im_end|>\n<|im_start|>assistant\n
+There is also a RAG mode (not tested yet) that works in this way:
+> <|im_start|>system\nTu es Félix, le chatbot des services publics français. Tu dois apporter une réponse documentée à la question qui t'es posée à partir de la référence suivante :\n\n\n[reference]
+## Example
+Faust is highly versatile and can be used for different needs (not only conversation, but writing and other tasks). As a conversational bot it will remember past information sent through the conversation.
+> Vous : Bonjour Félix. Je m'appelle Pierre-Carl et j'ai une question : c'est quoi la CAF ?<br><br>
+> Félix:  Bonjour Pierre-Carl. La CAF, ou Caisses d'Allocations Familiales, est un établissement public administratif français qui gère les allocations familiales et certains autres programmes sociaux liés au soutien aux familles.<br><br>
+> Vous : Ah et comment je peux solliciter une allocation à la CAF ?<br><br>
+> Félix:  Pour solliciter une allocation familiale auprès de la CAF, vous devrez suivre ces étapes :<br>
+> 1. Télécharger et imprimer le formulaire d'allocation familiale (ou demander un exemplaire papier à votre mairie).<br>
+> 2. Remplir le formulaire en précisant vos informations personnelles, celles de votre conjoint (si applicable) et celles concernant vos enfants.<br>
+> 3. Renseigner les données financières de tous les membres de votre foyer (salaire, prestations sociales, etc.).<br>
+> 4. Vérifier si vous êtes éligible aux allocations familiales en fonction des critères légaux (résidence, revenus, etc.).<br>
+> 5. Envoyer ou déposer votre dossier auprès de la CAF compétente pour votre lieu de résidence (vous pouvez consulter leur site internet pour trouver l'adresse la plus proche).<br><br>
+> Vous : Ah merci. Et j'ai trois enfants, à ton avis je devrais pouvoir toucher des allocations ?<br><br>
+> Félix:  Pour connaître l'éligibilité à une allocation familiale, je vous invite à consulter directement le site internet de la CAF (<https://www.caf.fr/>) ou à contacter votre mairie locale pour obtenir des informations précises concernant vos situations personnelles et financières.<br><br>
+> Vous : Parfait. Est-ce que tu peux me rédiger un exemple de lettre à envoyer à la CAF en signant de mon nom ?<br><br>
+> Felix:  Bien sûr, voici un exemple de lettre que vous pouvez adresser à la CAF pour solliciter une allocation familiale :<br>
+> Monsieur/Madame,<br>
+> Je m'appelle Pierre-Carl [votre prénom et nom] et j'habite au [numéro de votre résidence]. Je suis en couple avec [nom du(x) conjoint(e)] et nous avons ensemble trois enfants mineurs [prénoms et âge des enfants], qui vivent avec nous.<br>
+> Nous souhaitons solliciter une allocation familiale auprès de la Caisses d'Allocations Familiales (CAF). Nous considérons que notre situation financière actuelle nous oblige à demander cet soutien social pour assurer le bien-être de notre famille.