Skip to content

Commit 843806d

Browse files
authored
Convert docstring for Module.batch (#8310)
1 parent 9e4821e commit 843806d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

dspy/primitives/program.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,16 @@ def batch(
123123
"""
124124
Processes a list of dspy.Example instances in parallel using the Parallel module.
125125
126-
:param examples: List of dspy.Example instances to process.
127-
:param num_threads: Number of threads to use for parallel processing.
128-
:param max_errors: Maximum number of errors allowed before stopping execution.
129-
:param return_failed_examples: Whether to return failed examples and exceptions.
130-
:param provide_traceback: Whether to include traceback information in error logs.
131-
:return: List of results, and optionally failed examples and exceptions.
126+
Args:
127+
examples: List of dspy.Example instances to process.
128+
num_threads: Number of threads to use for parallel processing.
129+
max_errors: Maximum number of errors allowed before stopping execution.
130+
return_failed_examples: Whether to return failed examples and exceptions.
131+
provide_traceback: Whether to include traceback information in error logs.
132+
disable_progress_bar: Whether to display the progress bar.
133+
134+
Returns:
135+
List of results, and optionally failed examples and exceptions.
132136
"""
133137
# Create a list of execution pairs (self, example)
134138
exec_pairs = [(self, example.inputs()) for example in examples]

0 commit comments

Comments
 (0)