Reword comments in yaml configuration files (#7627)

GitOrigin-RevId: c1b95ec18734e99bd25838cb2d8fb883911a5b4c
pathwaycom · Nov 8, 2024 · 3629b52 · 3629b52
1 parent 4fab77f
commit 3629b52
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 27 deletions.
diff --git a/examples/pipelines/adaptive-rag/app.yaml b/examples/pipelines/adaptive-rag/app.yaml
@@ -46,7 +46,6 @@ $retriever_factory: !pw.stdlib.indexing.BruteForceKnnFactory
   embedder: $embedder
   metric: !pw.stdlib.indexing.BruteForceKnnMetricKind.COS
   dimensions: 1536
-
 
 $document_store: !pw.xpacks.llm.document_store.DocumentStore
   docs: $sources
@@ -62,13 +61,13 @@ question_answerer: !pw.xpacks.llm.question_answering.AdaptiveRAGQuestionAnswerer
   max_iterations: 4
   strict_prompt: true
 
-
 # Change host and port by uncommenting these lines
 # host: "0.0.0.0"
 # port: 8000
 
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true
diff --git a/examples/pipelines/demo-document-indexing/app.yaml b/examples/pipelines/demo-document-indexing/app.yaml
@@ -41,21 +41,20 @@ $retriever_factory: !pw.stdlib.indexing.BruteForceKnnFactory
   embedder: $embedder
   metric: !pw.stdlib.indexing.BruteForceKnnMetricKind.COS
   dimensions: 1536
-
 
 document_store: !pw.xpacks.llm.document_store.DocumentStore
   docs: $sources
   parser: $parser
   splitter: $splitter
   retriever_factory: $retriever_factory
 
-
-# Change host and port by uncommenting these files
+# Change host and port by uncommenting these lines
 # host: "0.0.0.0"
 # port: 8000
 
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true
diff --git a/examples/pipelines/demo-question-answering/app.yaml b/examples/pipelines/demo-question-answering/app.yaml
@@ -47,7 +47,6 @@ $retriever_factory: !pw.stdlib.indexing.BruteForceKnnFactory
   metric: !pw.stdlib.indexing.BruteForceKnnMetricKind.COS
   dimensions: 1536
 
-
 $document_store: !pw.xpacks.llm.document_store.DocumentStore
   docs: $sources
   parser: $parser
@@ -58,13 +57,13 @@ question_answerer: !pw.xpacks.llm.question_answering.BaseRAGQuestionAnswerer
   llm: $llm
   indexer: $document_store
 
-
-# Change host and port by uncommenting these files
+# Change host and port by uncommenting these lines
 # host: "0.0.0.0"
 # port: 8000
 
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true
diff --git a/examples/pipelines/gpt_4o_multimodal_rag/app.yaml b/examples/pipelines/gpt_4o_multimodal_rag/app.yaml
@@ -59,7 +59,6 @@ $retriever_factory: !pw.stdlib.indexing.BruteForceKnnFactory
   metric: !pw.engine.BruteForceKnnMetricKind.COS
   dimensions: 1536
 
-
 $document_store: !pw.xpacks.llm.document_store.DocumentStore
   docs: $sources
   parser: $parser
@@ -69,14 +68,13 @@ question_answerer: !pw.xpacks.llm.question_answering.BaseRAGQuestionAnswerer
   llm: $llm
   indexer: $document_store
 
-
-# Change host and port by uncommenting these files
+# Change host and port by uncommenting these lines
 # host: "0.0.0.0"
 # port: 8000
 
-
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true
diff --git a/examples/pipelines/private-rag/app.yaml b/examples/pipelines/private-rag/app.yaml
@@ -54,7 +54,6 @@ $retriever_factory: !pw.stdlib.indexing.BruteForceKnnFactory
   metric: !pw.engine.BruteForceKnnMetricKind.COS
   dimensions: 1536
 
-
 $document_store: !pw.xpacks.llm.document_store.DocumentStore
   docs: $sources
   parser: $parser
@@ -69,13 +68,13 @@ question_answerer: !pw.xpacks.llm.question_answering.AdaptiveRAGQuestionAnswerer
   max_iterations: 4
   strict_prompt: true
 
-
-# Change host and port by uncommenting these files
+# Change host and port by uncommenting these lines
 # host: "0.0.0.0"
 # port: 8000
 
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true
diff --git a/examples/pipelines/slides_ai_search/app.yaml b/examples/pipelines/slides_ai_search/app.yaml
@@ -79,5 +79,6 @@ details_schema:
 # Cache configuration
 # with_cache: true
 
-# Set `terminate_on_error` to true if you want the program to terminate whenever any error is encountered
-# terminate_on_error: false
+# If `terminate_on_error` is true then the program will terminate whenever any error is encountered.
+# Defaults to false, uncomment the following line if you want to set it to true
+# terminate_on_error: true