app.py

# -*- coding: utf-8 -*-
"""
app.py

This script creates a graphical interface to test an automatic evaluation generation model.
The model is available on Hugging Face and is based on the Llama 3.2 3B-instruct model.
model_id: "eltorio/Llama-3.2-3B-appreciation"

Author: Ronan Le Meillat
License: AGPL-3.0
"""
from threading import Thread
import gradio as gr
from transformers import (
    AutoProcessor,
    AutoTokenizer,
    AutoModelForCausalLM,
    TextIteratorStreamer,
)
from peft import AutoPeftModelForCausalLM
import torch
import os
import spaces

# Maximum execution time
thread_timeout = 600

if os.environ.get("HF_TOKEN") is None:
    raise ValueError(
        "You must set the HF_TOKEN environment variable to use this script, you also need to have access to the Llama 3.2 model family"
    )

# sets the main paremeters

# hugging_face_model_id = "eltorio/Llama-3.1-8B-appreciation"
# base_model_path = "meta-llama/Llama-3.1-8B-Instruct"

hugging_face_model_id = "eltorio/Llama-3.2-3B-appreciation"
base_model_path = "meta-llama/Llama-3.2-3B-Instruct"

device = 'cuda' if torch.cuda.is_available() else 'cpu'

# Define the title, description, and device description for the Gradio interface
device_desc = (
    f"🚀 Cette I.A. prend son aise sur ce GPU 🚀."
    if device == "cuda"
    else f"🐢 Cette I.A. est très très lente sur ce CPU 🐢."
)
title = f"Une intelligence artificielle pour écrire des appréciations qui tourne sur {device}"
desc = "Ce modèle vous propose une évaluation automatique."

# Define the long description for the Gradio interface
long_desc = f"Cette démonstration est basée sur le modèle <a href='https://huggingface.co/eltorio/Llama-3.2-3B-appreciation'>Llama-3.2-3B-appreciation</a>, c'est un LLM développé à l'aide de Llama 3.2 3B-instruct!<br><b>{device_desc}</b><br> 2024 - Ronan Le Meillat"

# Load the model
processor = AutoProcessor.from_pretrained(base_model_path, do_image_splitting=False)

model = AutoModelForCausalLM.from_pretrained(
    base_model_path,
    torch_dtype=torch.float16,
    low_cpu_mem_usage=True,
).to(device)
model.load_adapter(hugging_face_model_id)
tokenizer = AutoTokenizer.from_pretrained(hugging_face_model_id)


# Define a function to create the conversation from the incoming parameters
def get_conversation(
    trimestre: str,
    moyenne_1: float,
    moyenne_2: float,
    moyenne_3: float,
    comportement: float,
    participation: float,
    travail: float,
):

    if trimestre == "1":
        trimestre_full = "premier trimestre"
        user_question = f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_1} de moyenne, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
    elif trimestre == "2":
        trimestre_full = "deuxième trimestre"
        user_question = f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_2} de moyenne ce trimestre et {moyenne_1} au premier trimestre, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
    elif trimestre == "3":
        trimestre_full = "troisième trimestre"
        user_question = f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_3} de moyenne ce trimestre, {moyenne_2} au deuxième trimestre et {moyenne_1} au premier trimestre, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
    messages = [
        {
            "role": "system",
            "content": "Vous êtes une IA assistant les enseignants d'histoire-géographie en rédigeant à leur place une appréciation personnalisée pour leur élève en fonction de ses performances. Votre appreciation doit être en français, et doit aider l'élève à comprendre ses points forts et les axes d'amélioration. Votre appréciation doit comporter de 1 à 40 mots. Votre appréciation ne doit jamais comporter la valeur de la note. Votre appréciation doit utiliser le style impersonnel.Attention l'élément le plus important de votre analyse doit rester la moyenne du trimestre",
        },
        {"role": "user", "content": user_question},
    ]
    return messages


# Define a function to infer a evaluation from the incoming parameters
@spaces.GPU
def infere(
    trimestre: str,
    moyenne_1: float,
    moyenne_2: float,
    moyenne_3: float,
    comportement: float,
    participation: float,
    travail: float,
) -> str:
    if not torch.cuda.is_available():
        gr.Warning(
            """No GPU available.<br>
                    The answer will appear in around 10 minutes!<br>
                    But it takes only a few seconds on a decent GPU.<br>
                    Open a message in the <a href='https://huggingface.co/spaces/eltorio/Llama-3.2-3B-appreciation/discussions'>Community Discussion</a>.<br>
                    """,
            duration=500,
        )
    messages = get_conversation(
        trimestre, moyenne_1, moyenne_2, moyenne_3, comportement, participation, travail
    )

    # Tokenize the input
    inputs = tokenizer.apply_chat_template(
        messages,
        tokenize=True,
        add_generation_prompt=True,
        return_tensors="pt",
    ).to(device)

    # Start generation on a separate thread, so that we don't block the UI. The text is pulled from the streamer
    # in the main thread. Adds timeout to the streamer to handle exceptions in the generation thread.
    streamer = TextIteratorStreamer(
        tokenizer, timeout=thread_timeout, skip_prompt=True, skip_special_tokens=True
    )
    generate_kwargs = dict(
        input_ids=inputs,
        streamer=streamer,
        max_new_tokens=90,
        use_cache=True,
        pad_token_id=tokenizer.eos_token_id,
    )
    generation_thread = Thread(target=model.generate, kwargs=generate_kwargs)
    generation_thread.start()

    # Pull the generated text from the streamer, and update the model output.
    model_output = ""
    for new_text in streamer:
        model_output += new_text
        yield model_output,""
        
    return model_output, ""


# Create a Gradio interface with the infere function and specified title and descriptions
autoeval = gr.Interface(
    fn=infere,
    inputs=[
        gr.Radio(
            ["1", "2", "3"],
            value="1",
            label="Trimestre en cours",
            info="Sélectionnez le trimestre en cours à l'aide des boutons radio",
        ),
        gr.Slider(
            0,
            20,
            label="Moyenne au premier trimestre",
            value=10,
            info="Moyenne sur 20 obtenue au premier trimestre",
        ),
        gr.Slider(
            0,
            20,
            label="Moyenne au second trimestre",
            value=10,
            info="Moyenne sur 20 obtenue au second trimestre",
        ),
        gr.Slider(
            0,
            20,
            label="Moyenne au troisième trimestre",
            value=10,
            info="Moyenne sur 20 obtenue au troisième trimestre",
        ),
        gr.Slider(0, 10, value=5, label="Comportement", info="Comportement (1 à 10)"),
        gr.Slider(0, 10, value=5, label="Participation", info="Participation (1 à 10)"),
        gr.Slider(0, 10, value=5, label="Travail", info="Travail (1 à 10)"),
    ],
    outputs=[
        gr.Textbox(
            label="Sortie",
            info="Cette IA n'est pas finalisée, considérez ceci comme une idée pour rédiger votre appréciation.",
            interactive=False,
            show_copy_button=True
        ),
        gr.Textbox(
            label="Votre appréciation",
            info="Saisissez ici l'appréciation que vous avez mis à cet élève. Cliquer ensuite sur le bouton pour enregistrer votre proposition afin d'améliorer le modèle.",
            interactive=True,
            show_copy_button=True
        ),
    ],
    title=title,
    description=desc,
    article=long_desc,
    submit_btn="🚀",
    clear_btn="Effacer",
    flagging_options=[("Ajouter votre appréciation", "user")]
)

# Launch the Gradio interface and share it
autoeval.launch(server_name="0.0.0.0", share=True, ssr_mode=False)