Update app.py

app.py

@@ -24,7 +24,7 @@ entity_extraction_prompt = PromptTemplate(
 entity_chain = LLMChain(llm=llm, prompt=entity_extraction_prompt)
 
 def create_knowledge_graph(text):
-    # Extract entities and relationships
+    """Extracts entities and relationships from text and creates a knowledge graph."""
     result = entity_chain.run(text)
 
     # Parse the result and create a graph
@@ -47,6 +47,7 @@ def create_knowledge_graph(text):
     return G
 
 def visualize_graph(G):
+    """Visualizes the knowledge graph using matplotlib."""
     pos = nx.spring_layout(G)
     plt.figure(figsize=(12, 8))
     nx.draw(G, pos, with_labels=True, node_color='lightblue', node_size=3000, font_size=10, font_weight='bold')
@@ -58,6 +59,7 @@ def visualize_graph(G):
     return plt
 
 def generate_knowledge_graph(text):
+    """Generates and visualizes a knowledge graph from input text."""
     if text:
         knowledge_graph = create_knowledge_graph(text)
         fig = visualize_graph(knowledge_graph)
@@ -73,6 +75,20 @@ footer_html = """
     <a href="https://girishwangikar.github.io/Girish_Wangikar_Portfolio.github.io/" target="_blank">Portfolio</a></p>
 </footer>
 """
+
+# Instructions for using the app
+instructions_html = """
+<div>
+    <h2>Instructions:</h2>
+    <ol>
+        <li>Enter text in the input box that contains entities and their relationships. For example, "Paris - capital of: France".</li>
+        <li>Click the "Submit" button to generate the knowledge graph.</li>
+        <li>View the resulting knowledge graph visualization, which will display the entities as nodes and their relationships as labeled edges.</li>
+        <li>Feel free to experiment with different texts to explore relationships visually!</li>
+    </ol>
+</div>
+"""
+
 # Gradio interface
 iface = gr.Interface(
     fn=generate_knowledge_graph,
@@ -80,6 +96,7 @@ iface = gr.Interface(
     outputs=gr.Plot(),
     title="Knowledge Graph Generator",
     description="Enter text to generate a knowledge graph.",
+    article=instructions_html + footer_html,
     theme="default",
     css="""
     footer {
@@ -99,9 +116,7 @@ iface = gr.Interface(
     footer a:hover {
         text-decoration: underline;
     }
-    """,
-    article=footer_html
-)
+    """)
 
 # Launch the interface
 if __name__ == "__main__":