File size: 11,680 Bytes
8a18ce0
 
 
 
 
 
 
 
 
0cc549f
8a18ce0
 
0cc549f
 
 
8a18ce0
 
0cc549f
8a18ce0
0cc549f
 
a8115f1
 
 
 
8a18ce0
a8115f1
8a18ce0
 
 
 
 
 
 
 
 
 
 
 
0cc549f
8a18ce0
 
0cc549f
8a18ce0
 
 
 
 
 
0cc549f
8a18ce0
 
 
 
 
 
 
 
 
0cc549f
8a18ce0
 
abdb11b
 
 
8a18ce0
0cc549f
8a18ce0
0cc549f
 
 
 
8a18ce0
0cc549f
8a18ce0
 
 
 
 
 
d6afc31
 
 
8a18ce0
 
 
 
 
d6afc31
0cc549f
d6afc31
0cc549f
d6afc31
0cc549f
d6afc31
 
 
0cc549f
 
 
 
 
 
5ddef4d
b0271ee
0cc549f
 
d6afc31
0cc549f
8a18ce0
 
d6afc31
8a18ce0
 
 
 
 
 
 
 
 
d6afc31
8a18ce0
 
 
 
 
 
d6afc31
8a18ce0
 
d6afc31
 
0cc549f
 
d6afc31
0cc549f
 
 
d6afc31
0cc549f
8a18ce0
a8115f1
 
 
8a18ce0
 
0cc549f
a8115f1
8a18ce0
 
 
d6afc31
 
 
 
 
 
 
8a18ce0
d6afc31
8a18ce0
 
 
 
 
 
 
d6afc31
8a18ce0
 
 
 
610249f
8a18ce0
d6afc31
8a18ce0
 
 
d6afc31
 
 
 
 
 
 
8a18ce0
 
 
19a6387
 
5ddef4d
8a18ce0
19a6387
d6afc31
8a18ce0
 
 
 
 
 
 
 
d6afc31
8a18ce0
 
610249f
 
 
8a18ce0
d6afc31
8a18ce0
 
 
d6afc31
 
8a18ce0
 
d6afc31
 
8a18ce0
 
 
d6afc31
 
a8115f1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8a18ce0
0cc549f
8a18ce0
0cc549f
 
 
8a18ce0
0cc549f
8a18ce0
 
0cc549f
40cc997
8a18ce0
0cc549f
 
 
 
8a18ce0
 
 
 
 
 
 
 
 
 
 
0cc549f
8a18ce0
 
 
 
 
 
0cc549f
8a18ce0
 
0cc549f
8a18ce0
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
import gradio as gr
import spaces
from rag_system import RAGSystem
from i18n import get_text

# Initialize RAG system
rag = RAGSystem()

@spaces.GPU
def process_pdf(pdf_file, embedding_model, chunk_size, chunk_overlap):
    """Process uploaded PDF and create embeddings"""
    try:
        # Set embedding model BEFORE processing
        rag.set_embedding_model(embedding_model)

        if pdf_file is None:
            # Load default corpus
            status, chunks_display, corpus_text = rag.load_default_corpus(chunk_size, chunk_overlap)
        else:
            status, chunks_display, corpus_text = rag.process_document(pdf_file.name, chunk_size, chunk_overlap)

        # Generate example questions based on the corpus
        example_questions = rag.generate_example_questions(num_questions=5)

        return status, chunks_display, corpus_text, example_questions
    except Exception as e:
        return f"Error: {str(e)}", "", "", []

@spaces.GPU
def perform_query(
    query,
    top_k,
    similarity_threshold,
    llm_model,
    temperature,
    max_tokens
):
    """Perform RAG query and return results"""
    if not rag.is_ready():
        return "", "⚠️ Please process a corpus first in the Corpus tab.", "", ""

    try:
        # Set LLM model
        rag.set_llm_model(llm_model)

        # Retrieve relevant chunks
        results = rag.retrieve(query, top_k, similarity_threshold)

        # Format retrieved chunks display
        chunks_display = format_chunks(results)

        # Generate answer
        answer, prompt = rag.generate(
            query,
            results,
            temperature,
            max_tokens
        )

        return chunks_display, prompt, answer, ""

    except Exception as e:
        import traceback
        error_details = traceback.format_exc()
        return "", "", "", f"❌ Error: {str(e)}\n\nFull traceback:\n{error_details}"

def format_chunks(results):
    """Format retrieved chunks with scores for display"""
    if not results:
        return "No relevant chunks found."

    output = "### 📄 Retrieved Chunks\n\n"
    for i, (chunk, score) in enumerate(results, 1):
        output += f"**Chunk {i}** - Similarity Score: `{score:.4f}`\n"
        output += f"```\n{chunk}\n```\n\n"
    return output

def create_interface():
    with gr.Blocks(title="RAG Pedagogical Demo", theme=gr.themes.Soft()) as demo:

        # Header - Bilingual
        gr.Markdown("# 🎓 RAG Pedagogical Demo / Démo Pédagogique RAG")
        gr.Markdown("*A pedagogical tool to understand Retrieval Augmented Generation / Un outil pédagogique pour comprendre la génération augmentée par récupération*")

        with gr.Tabs() as tabs:

            # Tab 1: Corpus Management
            with gr.Tab(label="📚 Corpus"):
                gr.Markdown("## Corpus Management / Gestion du Corpus")
                gr.Markdown("""
                **EN - Default corpus:** Multiple PDF documents from the `documents/` folder. Or upload your own PDF.

                **FR - Corpus par défaut :** Plusieurs documents PDF du dossier `documents/`. Ou téléchargez votre propre PDF.

                1. Select your embedding model / Sélectionnez votre modèle d'embedding
                2. Adjust chunking parameters if needed / Ajustez les paramètres de découpage si nécessaire
                3. Click "Process Corpus" / Cliquez sur "Process Corpus"
                """)

                # Embedding model selection FIRST
                embedding_model = gr.Dropdown(
                    choices=[
                        "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
                        "intfloat/multilingual-e5-base",
                        "ibm-granite/granite-embedding-107m-multilingual",
                    ],
                    value="sentence-transformers/all-MiniLM-L6-v2",
                    label="🔤 Embedding Model / Modèle d'Embedding (select before processing / sélectionnez avant traitement)"
                )

                pdf_upload = gr.File(
                    label="📄 Upload PDF / Télécharger PDF (optional / optionnel)",
                    file_types=[".pdf"]
                )

                with gr.Row():
                    chunk_size = gr.Slider(
                        minimum=100,
                        maximum=1000,
                        value=500,
                        step=50,
                        label="Chunk Size / Taille des Chunks (characters / caractères)"
                    )
                    chunk_overlap = gr.Slider(
                        minimum=0,
                        maximum=200,
                        value=50,
                        step=10,
                        label="Chunk Overlap / Chevauchement (characters / caractères)"
                    )

                process_btn = gr.Button("🚀 Process Corpus / Traiter le Corpus", variant="primary", size="lg")
                corpus_status = gr.Textbox(label="Status / Statut", interactive=False)

                # Display default corpus info
                with gr.Accordion("📖 Corpus Information / Informations sur le Corpus", open=False):
                    default_corpus_display = gr.Markdown()

                # Display processed chunks
                with gr.Accordion("📑 Processed Chunks / Chunks Traités", open=False):
                    processed_chunks_display = gr.Markdown()

                # State to hold example questions
                example_questions_state = gr.State([])

                process_btn.click(
                    fn=process_pdf,
                    inputs=[pdf_upload, embedding_model, chunk_size, chunk_overlap],
                    outputs=[corpus_status, processed_chunks_display, default_corpus_display, example_questions_state]
                )

            # Tab 2: Retrieval Configuration
            with gr.Tab(label="🔍 Retrieval / Récupération"):
                gr.Markdown("## Retrieval Configuration / Configuration de la Récupération")
                gr.Markdown("""
                **EN:** Configure how relevant chunks are retrieved from the corpus.

                **FR:** Configurez comment les chunks pertinents sont récupérés du corpus.
                """)

                gr.Markdown("**Current Embedding Model / Modèle d'Embedding Actuel:** The model selected in the Corpus tab / Le modèle sélectionné dans l'onglet Corpus")

                with gr.Row():
                    top_k = gr.Slider(
                        minimum=1,
                        maximum=10,
                        value=3,
                        step=1,
                        label="Top K (number of chunks / nombre de chunks à récupérer)"
                    )
                    similarity_threshold = gr.Slider(
                        minimum=0.0,
                        maximum=1.0,
                        value=0.5,
                        step=0.05,
                        label="Similarity Threshold / Seuil de Similarité (minimum score / score minimum)"
                    )

            # Tab 3: Generation Configuration
            with gr.Tab(label="🤖 Generation / Génération"):
                gr.Markdown("## Generation Configuration / Configuration de la Génération")
                gr.Markdown("""
                **EN:** Select the language model and configure generation parameters.

                **FR:** Sélectionnez le modèle de langage et configurez les paramètres de génération.
                """)

                llm_model = gr.Dropdown(
                    choices=[
                        "meta-llama/Llama-3.2-1B-Instruct",
                        "Qwen/Qwen3-1.7B",
                        "google/gemma-2-2b-it",
                    ],
                    value="meta-llama/Llama-3.2-1B-Instruct",
                    label="Language Model / Modèle de Langage"
                )

                with gr.Row():
                    temperature = gr.Slider(
                        minimum=0.0,
                        maximum=2.0,
                        value=0.7,
                        step=0.1,
                        label="Temperature / Température (creativity / créativité)"
                    )
                    max_tokens = gr.Slider(
                        minimum=100,
                        maximum=2048,
                        value=800,
                        step=50,
                        label="Max Tokens (response length / longueur réponse - higher for reasoning / plus pour raisonnement)"
                    )

            # Tab 4: Query & Results
            with gr.Tab(label="💬 Query / Requête"):
                gr.Markdown("## Ask a Question / Posez une Question")

                query_input = gr.Textbox(
                    label="Your Question / Votre Question",
                    placeholder="Enter your question here / Entrez votre question ici...",
                    lines=3
                )

                with gr.Accordion("💡 Example Questions / Questions d'Exemple (click to expand / cliquez pour développer)", open=True):
                    gr.Markdown("*Questions generated based on your corpus content / Questions générées à partir de votre corpus*")
                    examples_markdown = gr.Markdown(visible=False)

                    # Connect processing to update examples
                    def format_questions_markdown(questions):
                        if not questions or len(questions) == 0:
                            return gr.update(value="", visible=False)

                        md = ""
                        for i, q in enumerate(questions, 1):
                            md += f"{i}. {q}\n\n"
                        return gr.update(value=md, visible=True)

                    example_questions_state.change(
                        fn=format_questions_markdown,
                        inputs=[example_questions_state],
                        outputs=[examples_markdown]
                    )

                query_btn = gr.Button("🔍 Submit Query", variant="primary", size="lg")

                # Results in order: chunks → prompt → answer
                gr.Markdown("---")
                gr.Markdown("### 📊 Results")

                with gr.Accordion("1️⃣ Retrieved Chunks", open=True):
                    chunks_output = gr.Markdown()

                with gr.Accordion("2️⃣ Prompt Sent to LLM", open=True):
                    prompt_output = gr.Textbox(lines=10, max_lines=20, show_copy_button=True)

                with gr.Accordion("3️⃣ Generated Answer", open=True):
                    answer_output = gr.Markdown()

                error_output = gr.Textbox(label="Errors", visible=False)

                query_btn.click(
                    fn=perform_query,
                    inputs=[
                        query_input,
                        top_k,
                        similarity_threshold,
                        llm_model,
                        temperature,
                        max_tokens
                    ],
                    outputs=[chunks_output, prompt_output, answer_output, error_output]
                )

        # Footer
        gr.Markdown("""
        ---
        **Note**: This is a pedagogical demonstration of RAG systems.
        Models run on HuggingFace infrastructure.

        **Note** : Ceci est une démonstration pédagogique des systèmes RAG.
        Les modèles tournent sur l'infrastructure HuggingFace.
        """)

    return demo

if __name__ == "__main__":
    demo = create_interface()
    demo.launch()