Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Update copro_optimizer.py docstring

arnavsinghvi11c99df693ec76
diff --git a/dspy/teleprompt/copro_optimizer.py b/dspy/teleprompt/copro_optimizer.py
index 1d1878ba9..edb0df882 100644
--- a/dspy/teleprompt/copro_optimizer.py
+++ b/dspy/teleprompt/copro_optimizer.py
@@ -127,21 +127,15 @@ class COPRO(Teleprompter):
def compile(self, student, *, trainset, eval_kwargs):
"""
- Optimize the `signature` of `student`.
- `student` is a program that needs to be optimized, note that it may be zero-shot or already pre-optimized
- (the demos are already chosen).
-
- Parameters
- ==========
- student:
- The program to optimize. Will not be modified.
+ optimizes `signature` of `student` program - note that it may be zero-shot or already pre-optimized (demos already chosen - `demos != []`)
+
+ parameters:
+ student: program to optimize and left modified.
trainset: iterable of `Example`s
eval_kwargs: optional, dict
Additional keywords to go into `Evaluate` for the metric.
- Returns
- =======
- Optimized version of `student`.
+ Returns optimized version of `student`.
"""
module = student.deepcopy()
evaluate = Evaluate(devset=trainset, metric=self.metric, **eval_kwargs)