Merge remote-tracking branch 'origin/dev' into dev

Author: NotBioWaste905

README.md

@@ -37,15 +37,90 @@ Supported types of graphs:
 
 - [x]  chain
 - [x]  single cycle
+- [x]  multi-cycle graph
+- [x]  complex graph with cycles
 
 Currently unsupported types:
 
 - [ ]  single node cycle
-- [ ]  multi-cycle graph
 - [ ]  incomplete graph
-- [ ]  complex graph with cycles
 
-## Current algorithms progress
+## How to use
+We provide several of using our library for various tasks.
+### Data generation
+
+```python
+from chatsky_llm_autoconfig.algorithms.cycle_graph_generation_pipeline import GraphGenerationPipeline
+from langchain_openai import ChatOpenAI
+
+
+generation_model = ChatOpenAI(
+        model='deepseek/deepseek-reasoner',
+        api_key=os.getenv("OPENAI_API_KEY"),
+        base_url=os.getenv("OPENAI_BASE_URL"),
+        temperature=0.2
+    )
+    
+validation_model = ChatOpenAI(
+    model='gpt-4o-mini',
+    api_key=os.getenv("OPENAI_API_KEY"),
+    base_url=os.getenv("OPENAI_BASE_URL"),
+    temperature=0
+
+pipeline = GraphGenerationPipeline(
+        generation_model=generation_model,
+        validation_model=validation_model
+    )
+    
+topics = [
+    "technical support conversation",
+    "job interview",
+    "restaurant reservation",
+    "online shopping checkout",
+    "travel booking"
+]
+
+successful_generations = []
+
+for topic in topics:
+
+    try:
+        result = pipeline(topic)
+        
+        # Check the result type
+        if isinstance(result, GraphGenerationResult):
+            print(f"✅ Successfully generated graph for {topic}")
+            # Save the full result with the graph and dialog
+            successful_generations.append({
+                "graph": result.graph.model_dump(),
+                "topic": result.topic,
+                "dialogues": [d.model_dump() for d in result.dialogues]
+            })
+        else:  # isinstance(result, GenerationError)
+            print(f"❌ Failed to generate graph for {topic}")
+            print(f"Error type: {result.error_type}")
+            print(f"Error message: {result.message}")
+                
+    except Exception as e:
+        print(f"❌ Unexpected error processing topic '{topic}': {str(e)}")
+        continue
+```
+
+### Dialogue sampling
+
+```python
+from chatsky_llm_autoconfig.algorithms.dialogue_generation import RecursiveDialogueSampler
+from chatsky_llm_autoconfig.graph import Graph
+
+G = Graph(graph_dict={...})
+
+sampler = RecursiveDialogueSampler()
+sampler.invoke(graph=G) #-> list of Dialogue objects
+
+```
+
+### Graph generation
+### Evaluation
 
 - Generate graph from scratch by topic (input: topic, output: graph) (for dataset generation)
   - algorithms.topic_graph_generation.CycleGraphGenerator