doc: Examples update and related minor bug fix

examples/basic_modules/embedder.py

@@ -3,7 +3,10 @@
 
 
 # Scenario 1: Using EmbedderFactory
-
+# Prerequisites:
+# 1. Install Ollama: https://ollama.com/
+# 2. Start Ollama server: `ollama serve`
+# 3. Pull the model: `ollama pull nomic-embed-text`
 config = EmbedderConfigFactory.model_validate(
     {
         "backend": "ollama",
@@ -33,6 +36,9 @@
 
 
 # Scenario 3: Using SenTranEmbedder
+# Prerequisites:
+# 1. Ensure `einops` is installed: `pip install einops` (Required for some HF models like nomic-bert)
+# 2. The model `nomic-ai/nomic-embed-text-v1.5` will be downloaded automatically from HuggingFace.
 
 config_hf = EmbedderConfigFactory.model_validate(
     {
@@ -49,6 +55,9 @@
 print("==" * 20)
 
 # === Scenario 4: Using UniversalAPIEmbedder(OpenAI) ===
+# Prerequisites:
+# 1. Set a valid OPENAI_API_KEY
+# 2. Ensure the base_url is reachable
 
 config_api = EmbedderConfigFactory.model_validate(
     {
@@ -68,6 +77,9 @@
 print("Embedding preview:", embedding_api[0][:10])
 
 # === Scenario 5: Using UniversalAPIEmbedder(Azure) ===
+# Prerequisites:
+# 1. Set a valid AZURE_API_KEY
+# 2. Ensure the base_url is reachable
 
 config_api = EmbedderConfigFactory.model_validate(
     {

examples/basic_modules/llm.py

@@ -5,6 +5,10 @@
 
 # Scenario 1: Using LLMFactory with Ollama Backend
 # This is the most recommended way! 🌟
+# Prerequisites:
+# 1. Install Ollama: https://ollama.com/
+# 2. Start Ollama server: `ollama serve`
+# 3. Need python ollama package(>=0.5.0,<0.6.0)
 
 config = LLMConfigFactory.model_validate(
     {
@@ -46,6 +50,10 @@
 
 
 # Scenario 3: Using LLMFactory with OpenAI Backend
+# Prerequisites:
+# 1. You need a valid OpenAI API key to run this scenario.
+# 2. Replace 'sk-xxxx' with your actual API key below.
+
 
 config = LLMConfigFactory.model_validate(
     {