dspy.RLM¶
RLM (Recursive Language Model) is a DSPy module that lets LLMs programmatically explore large contexts through a sandboxed Python REPL. Instead of feeding huge contexts directly into the prompt, RLM treats context as external data that the LLM examines via code execution and recursive sub-LLM calls.
This implements the approach described in “Recursive Language Models” (Zhang, Kraska, Khattab, 2025).
Migrating from CodeAct or ProgramOfThought¶
dspy.CodeAct and dspy.ProgramOfThought were deprecated in DSPy 3.4 and removed in DSPy 3.5, including their dspy.predict imports. Use dspy.RLM for code-executing programs. It is a replacement, not a compatibility alias.
Keep your task signature and named inputs, and replace the module constructor:
import dspy
# After configuring dspy.settings.lm:
solve = dspy.RLM("question -> answer")
result = solve(question="What is 12 factorial divided by the sum of primes below 30?")
print(result.answer)
def add(a: int, b: int) -> int:
"""Add two integers."""
return a + b
# For programs that previously supplied tools:
agent = dspy.RLM("question -> answer", tools=[add])
- RLM runs an iterative Python REPL and submits the signature’s output fields with
SUBMIT(...). It does not use the oldgenerated_code/finishedprotocol or the three code-generation, regeneration, and answer predictors. Custom prompts and code that accessed those internal predictors must be rewritten. max_itersnow limits REPL iterations, not just code-repair attempts. Review your iteration budget rather than assuming the old value has identical semantics.max_llm_callsseparately limits sub-LM calls.- Pass tools with
tools=[...]. RLM exposes them as host-side callables through the interpreter, rather than copying their source definitions into the sandbox. Host tools retain their own dependencies and privileges; sandbox restrictions do not apply to their host-side execution. interpreter_factory=...anddspy.configure(interpreter_factory=...)remain supported. RLM requires an interpreter that supports its mutable tools dictionary and sandbox DSPy facade; see interpreter factories. RLM does not accept a caller-owned interpreter as a positional override.- Rebuild and re-optimize programs that used the removed modules. Their saved predictor states and internal trajectory formats are not interchangeable with RLM’s.
See the RLM deep dive for execution, outputs, and interpreter lifecycle details, and the installation instructions below for the default sandbox runtime.
When to Use RLM¶
As contexts grow, LLM performance degrades — a phenomenon known as context rot. RLMs address this by separating the variable space (information stored in the REPL) from the token space (what the LLM actually processes). The LLM dynamically loads only the context it needs, when it needs it.
Use RLM when:
- Your context is too large to fit in the LLM’s context window effectively
- The task benefits from programmatic exploration (searching, filtering, aggregating, chunking)
- You need the LLM to decide how to decompose the problem, not you
Basic Usage¶
import dspy
dspy.configure(lm=dspy.LM("openai/gpt-5"))
# Create an RLM module
rlm = dspy.RLM("context, query -> answer")
# Call it like any other module
result = rlm(
context="...very long document or data...",
query="What is the total revenue mentioned?"
)
print(result.answer)
Deno Installation¶
RLM relies on Deno and Pyodide to create a local WASM sandbox for secure Python execution.
Install DSPy’s managed Deno runtime with pip install "dspy[deno]". See the PythonInterpreter installation guide for supported platforms, system-Deno fallback instructions, and dependency-isolation details.
Then you can run dspy.RLM.
You can also work with an external sandbox provider. We are still working on creating an example of using external sandbox providers.
How It Works¶
RLM operates in an iterative REPL loop:
- The LLM receives metadata about the context (type, length, preview) but not the full context
- The LLM writes Python code to explore the data (print samples, search, filter)
- Code executes in a sandboxed interpreter, and the LLM sees the output
- The LLM can call
llm_query(prompt)to run sub-LLM calls for semantic analysis on snippets - When done, the LLM calls
SUBMIT(output)to return the final answer
What the LLM sees (step-by-step trace):¶
Step 1: Initial Metadata (no direct access to full context)¶
Output shown to the LLM:Step 2: Write Code to Explore Context¶
# Step 2: Search for relevant sections
import re
matches = re.findall(r'revenue.*?\$[\d,]+', context, re.IGNORECASE)
print(matches)
Step 3: Trigger Sub-LLM Calls¶
# Step 3: Use sub-LLM for semantic extraction
result = llm_query(f"Extract the total revenue from: {matches[1]}")
print(result)
Step 4: Submit Final Answer¶
Output shown to the user:Constructor Parameters¶
| Parameter | Type | Default | Description |
|---|---|---|---|
signature | str \| Signature | required | Defines inputs and outputs (e.g., "context, query -> answer") |
max_iters | int | 20 | Maximum REPL interaction loops before fallback extraction |
max_llm_calls | int | 50 | Maximum llm_query/llm_query_batched calls per execution |
max_output_chars | int | 10_000 | Maximum characters to include from REPL output |
verbose | bool | False | Log detailed execution info |
tools | list[Union[Callable, dspy.Tool]] | None | Additional tool functions callable from interpreter code |
sub_lm | dspy.LM | None | LM for sub-queries. Defaults to dspy.settings.lm. Use a cheaper model here. |
interpreter_factory | Callable[[], CodeInterpreter] | PythonInterpreter | Creates one interpreter per invocation. RLM shuts down each returned interpreter. dspy.configure(interpreter_factory=...) replaces the default. A factory passed to the constructor wins, unless it is PythonInterpreter. May expose an optional execution_instructions string for the action prompt. |
Built-in Tools¶
Inside the REPL, the LLM has access to:
| Tool | Description |
|---|---|
llm_query(prompt) | Query a sub-LLM for semantic analysis (~500K char capacity). prompt may be a list of strings and DSPy values, such as images |
llm_query_batched(prompts) | Query multiple prompts concurrently (faster for batch operations) |
print() | Print output (required to see results) |
SUBMIT(...) | Submit final output and end execution |
| Standard library | re, json, collections, math, etc. |
Examples¶
Long Document Q&A¶
import dspy
dspy.configure(lm=dspy.LM("openai/gpt-5"))
rlm = dspy.RLM("document, question -> answer", max_iters=10)
with open("large_report.txt") as f:
document = f.read() # 500K+ characters
result = rlm(
document=document,
question="What were the key findings from Q3?"
)
print(result.answer)
Using a Cheaper Sub-LM¶
import dspy
main_lm = dspy.LM("openai/gpt-5")
cheap_lm = dspy.LM("openai/gpt-5-nano")
dspy.configure(lm=main_lm)
# Root LM (gpt-5) decides strategy; sub-LM (gpt-5-nano) handles extraction
rlm = dspy.RLM("data, query -> summary", sub_lm=cheap_lm)
Multiple Typed Outputs¶
rlm = dspy.RLM("logs -> error_count: int, critical_errors: list[str]")
result = rlm(logs=server_logs)
print(f"Found {result.error_count} errors")
print(f"Critical: {result.critical_errors}")
Custom Tools¶
def fetch_metadata(doc_id: str) -> str:
"""Fetch metadata for a document ID."""
return database.get_metadata(doc_id)
rlm = dspy.RLM(
"documents, query -> answer",
tools=[fetch_metadata]
)
Configuring the Interpreter¶
Pass the interpreter class directly when it needs no arguments. For configured construction, use any zero-argument callable, such as functools.partial:
from functools import partial
rlm = dspy.RLM(
"context, query -> answer",
interpreter_factory=partial(
dspy.PythonInterpreter,
enable_network_access=["example.com"],
),
)
One call puts the same interpreter behind every code-executing module in the program. Each invocation reads the setting, so dspy.context(interpreter_factory=...) scopes the choice and dspy.configure(...) reaches modules built before the call. A factory passed to a constructor still wins, unless it is PythonInterpreter:
RLM creates and shuts down one interpreter from this factory per invocation. It adds invocation-scoped tools to the returned interpreter’s mutable tools dictionary, so remote sandboxes need a CodeInterpreter adapter that supports that protocol.
To override the factory for a single invocation, pass a zero-argument callable via the interpreter_factory keyword:
result = rlm(context=data, query=query, interpreter_factory=MyInterpreter)
result = await rlm.acall(context=data, query=query, interpreter_factory=MyInterpreter)
The call-time factory takes precedence over constructor and global/context factories, including when explicitly passing PythonInterpreter. RLM calls it once and shuts down the returned interpreter on success or failure. The factory must return a fresh interpreter each time. Passing a live interpreter at call time is no longer supported; migrate rlm(interpreter, ...) to rlm(..., interpreter_factory=factory). The option is keyword-only, and interpreter_factory is reserved for runtime configuration rather than signature inputs.
If the factory exposes an execution_instructions string, RLM adds it to the action predictor’s task instructions, which DSPy adapters place in the system prompt. Optimizers such as GEPA may therefore adapt the execution guidance along with the rest of the action policy. Factory classes and configured callable provider objects can expose this metadata; anonymous factories without it continue to use the generic action prompt. RLM refreshes these instructions for each action call, so a dspy.context(interpreter_factory=...) override keeps the prompt aligned with the runtime that executes the generated code.
Custom Sandbox-Serializable Inputs¶
For inputs that should be loaded into the sandbox differently from normal Python values, subclass dspy.SandboxSerializable. RLM detects these inputs, sends their serialized payload into the interpreter, runs their setup code, and exposes the reconstructed value under the original input name.
The value crosses on the same path as every other value the interpreter’s JSON can’t carry (dspy.Image and other dspy types): it is rebuilt once per call, so changes the code makes to it persist across turns. The same holds for a dspy.Flex input, and for a provided tool’s result. In RLM, a tool’s result is rebuilt only when the tool’s return annotation names its type (for example -> DataFrame); otherwise RLM reports an error rather than passing the value’s string. Three limits:
- Only host values are rebuilt. A
SandboxSerializabledefined by sandboxed code and passed to a host tool is refused: the host never runs code the sandbox wrote. - It is one-way. A value that comes back from the sandbox (via
SUBMITor a tool argument) is whatever the code returns, not a rebuiltSandboxSerializable. - It needs dspy inside the interpreter. An interpreter that can’t load it (for example a restricted compiler, or a sandbox without its cached bundle offline) raises an error for these inputs.
class DataFrame(dspy.SandboxSerializable):
def sandbox_setup(self) -> str:
return "import pandas as pd\nimport base64\nimport io"
def to_sandbox(self) -> bytes:
return base64.b64encode(self.data.to_parquet(index=False))
def sandbox_assignment(self, var_name: str, data_expr: str) -> str:
return f"{var_name} = pd.read_parquet(io.BytesIO(base64.b64decode({data_expr})))"
def rlm_preview(self, max_chars: int = 500) -> str:
return f"DataFrame: {self.data.shape[0]} rows x {self.data.shape[1]} columns"
SandboxSerializable also defines a Pydantic schema hook so subclasses can be used directly in DSPy signatures, for example data: DataFrame = dspy.InputField(). The hook is intentionally pass-through: Pydantic accepts the object as-is and serializes it with str(value) for schema/metadata purposes. RLM’s real sandbox transport still comes from to_sandbox() and sandbox_assignment().
Images and Other DSPy Types¶
Values of DSPy types such as dspy.Image keep their type across the REPL boundary: in inputs, tool arguments and results, SUBMIT, llm_query prompt lists, and sub-agents built with dspy in the REPL. The REPL runs dspy itself, so a dspy.Image is a dspy.Image there, with its methods. Your own dspy.Type subclasses and models arrive as plain data of their fields, with their methods left on the host, as in dspy.Flex. A tool’s result keeps its type when the tool’s return annotation names it (-> dspy.Image).
dspy.Image.to_pil() needs Pillow in the interpreter. dspy.LocalInterpreter uses your environment’s. PythonInterpreter’s sandbox includes Pyodide’s build of Pillow, whether or not your environment has Pillow. Its sandbox_packages choose the packages Pyodide ships that the REPL can import, by default ("pillow",):
from functools import partial
import dspy
# numpy as well as Pillow
rlm = dspy.RLM(
"photo: dspy.Image, question -> answer",
interpreter_factory=partial(
dspy.PythonInterpreter,
sandbox_packages=["pillow", "numpy"],
),
)
# no packages, for a sandbox that starts slightly faster;
# images still pass through, but to_pil() raises ImportError
dspy.configure(
interpreter_factory=partial(
dspy.PythonInterpreter,
sandbox_packages=[],
),
)
def take_screenshot() -> dspy.Image:
...
rlm = dspy.RLM("photo: dspy.Image, question -> answer, crop: dspy.Image", tools=[take_screenshot])
The model can then write code such as:
crop = dspy.Image(photo.to_pil().crop((600, 400, 900, 600)))
label = llm_query(["Read the label in this crop.", crop])
screen = take_screenshot() # a dspy.Image
answer = dspy.Predict("image: dspy.Image, question -> answer")(image=screen, question=question).answer
SUBMIT(answer, crop)
Async Execution¶
import asyncio
rlm = dspy.RLM("context, query -> answer")
async def process():
result = await rlm.acall(context=data, query="Summarize this")
return result.answer
answer = asyncio.run(process())
Inspecting the Trajectory¶
result = rlm(context=data, query="Find the magic number")
# See what code the LLM executed
for step in result.trajectory:
print(f"Code:\n{step['code']}")
print(f"Output:\n{step['output']}\n")
Output¶
RLM returns a Prediction with:
- Output fields from your signature (e.g.,
result.answer) trajectory: List of dicts withreasoning,code,outputfor each stepfinal_reasoning: The LLM’s reasoning on the final step
Notes¶
Thread Safety
Constructor and call-time factories may be called concurrently and must return a fresh interpreter each time. RLM retains that interpreter throughout one invocation and shuts it down afterward. PythonInterpreter must stay on the thread where it was first used.
Interpreter Requirements
RLM defaults to PythonInterpreter, which requires Deno to be installed for the Pyodide WASM sandbox. LocalInterpreter requires no additional runtime and provides a separate CPython process, but it is not a security sandbox: generated code retains the host user’s files, environment, credentials, network, and process authority.
API Reference¶
dspy.RLM(signature: type[Signature] | str, max_iters: int = 20, max_llm_calls: int = 50, max_output_chars: int = 10000, verbose: bool = False, tools: list[Callable] | None = None, sub_lm: dspy.LM | None = None, interpreter_factory: Callable[[], CodeInterpreter] = PythonInterpreter, *, history_processor: Callable[[dspy.History], dspy.History | None] | None = None) ¶
Bases: Module
Recursive Language Model module.
Uses a sandboxed REPL to let the LLM programmatically explore large contexts through code execution. The LLM writes Python code to examine data, call sub-LLMs for semantic analysis, and build up answers iteratively.
interpreter_factory defaults to PythonInterpreter (Deno/Pyodide/WASM), and dspy.configure(interpreter_factory=...) replaces that default. Either route accepts an adapter for a remote sandbox. RLM updates the interpreter’s mutable tools dictionary with invocation-scoped tools before execution. Pass a zero-argument factory via interpreter_factory= at call time to override the runtime for one invocation. RLM shuts down every interpreter it creates.
Examples:
# Basic usage
rlm = dspy.RLM("context, query -> output", max_iters=10)
result = rlm(context="...very long text...", query="What is the magic number?")
print(result.output)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
signature | type[Signature] | str | Defines inputs and outputs. String like “context, query -> answer” or a Signature class. | required |
max_iters | int | Maximum REPL interaction iterations. | 20 |
max_llm_calls | int | Maximum sub-LLM calls (llm_query/llm_query_batched and sub-agent LM calls) per execution. | 50 |
max_output_chars | int | Maximum characters to include from REPL output. | 10000 |
verbose | bool | Whether to log detailed execution info. | False |
history_processor | Callable[[History], History | None] | None | Optional callable applied to the conversation history before each iteration (e.g. to truncate or summarize it). It receives a deep copy of the current | None |
tools | list[Callable] | None | List of tool functions or dspy.Tool objects callable from interpreter code. Built-in tools: llm_query(prompt), llm_query_batched(prompts). | None |
sub_lm | LM | None | LM for llm_query/llm_query_batched and sub-agents. Defaults to dspy.settings.lm. Allows using a different (e.g., cheaper) model for sub-queries. | None |
interpreter_factory | Callable[[], CodeInterpreter] | Zero-argument callable that creates an interpreter for each forward pass. The callable may be invoked concurrently, and DSPy shuts down each interpreter it returns. RLM updates the returned interpreter’s mutable | PythonInterpreter |
Source code in dspy/predict/rlm.py
Attributes¶
tools: dict[str, Tool] property ¶
User-provided tools (excludes internal llm_query/llm_query_batched).
Methods:¶
__call__(*args, **kwargs) -> Prediction ¶
Source code in dspy/primitives/module.py
forward(*, interpreter_factory: Callable[[], CodeInterpreter] | None = None, history_processor: Callable[[dspy.History], dspy.History | None] | None = None, **input_args) -> Prediction ¶
Execute RLM to produce outputs from the given inputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
interpreter_factory | Callable[[], CodeInterpreter] | None | Optional zero-argument factory, passed by keyword. Overrides the constructor and configured factories for this invocation. Must return a fresh interpreter; RLM injects tools and output metadata and shuts it down on exit, including failures. Sub-agents built in the sandbox run their own code on this factory too. | None |
history_processor | Callable[[History], History | None] | None | Optional callable, passed by keyword. Overrides the constructor’s processor for this invocation; see the class docstring for the contract. | None |
**input_args | Input values matching the signature’s input fields. An optional | {} |
Returns:
| Type | Description |
|---|---|
Prediction | Prediction with the signature’s outputs, |
Prediction |
|
Prediction | iteration; pass it back as |
Prediction | interpreter variables or mutations; each invocation uses a fresh interpreter. |
Raises:
| Type | Description |
|---|---|
ValueError | If required input fields are missing |
CodeInterpreterError | If interpreter setup, process, or protocol fails |
Source code in dspy/predict/rlm.py
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 | |
aforward(*, interpreter_factory: Callable[[], CodeInterpreter] | None = None, history_processor: Callable[[dspy.History], dspy.History | None] | None = None, **input_args) -> Prediction async ¶
Async version of forward(). Execute RLM to produce outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
interpreter_factory | Callable[[], CodeInterpreter] | None | Optional zero-argument factory, passed by keyword. Overrides the constructor and configured factories for this invocation. Must return a fresh interpreter; RLM injects tools and output metadata and shuts it down on exit, including failures. Sub-agents built in the sandbox run their own code on this factory too. | None |
history_processor | Callable[[History], History | None] | None | Optional callable, passed by keyword. Overrides the constructor’s processor for this invocation; see the class docstring for the contract. | None |
**input_args | Input values matching the signature’s input fields. An optional | {} |
Returns:
| Type | Description |
|---|---|
Prediction | Prediction with the signature’s outputs, |
Prediction |
|
Prediction | iteration; pass it back as |
Prediction | interpreter variables or mutations; each invocation uses a fresh interpreter. |
Raises:
| Type | Description |
|---|---|
ValueError | If required input fields are missing |
CodeInterpreterError | If interpreter setup, process, or protocol fails |
Source code in dspy/predict/rlm.py
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 | |
batch(examples: list[Example], num_threads: int | None = None, max_errors: int | None = None, return_failed_examples: bool = False, provide_traceback: bool | None = None, disable_progress_bar: bool = False, timeout: int = 120, straggler_limit: int = 3) -> list[Example] | tuple[list[Example], list[Example], list[Exception]] ¶
Processes a list of dspy.Example instances in parallel using the Parallel module.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
examples | list[Example] | List of dspy.Example instances to process. | required |
num_threads | int | None | Number of threads to use for parallel processing. | None |
max_errors | int | None | Maximum number of errors allowed before stopping execution. If | None |
return_failed_examples | bool | Whether to return failed examples and exceptions. | False |
provide_traceback | bool | None | Whether to include traceback information in error logs. | None |
disable_progress_bar | bool | Whether to display the progress bar. | False |
timeout | int | Seconds before a straggler task is resubmitted. Set to 0 to disable. | 120 |
straggler_limit | int | Only check for stragglers when this many or fewer tasks remain. | 3 |
Returns:
| Type | Description |
|---|---|
list[Example] | tuple[list[Example], list[Example], list[Exception]] | List of results, and optionally failed examples and exceptions. |
Source code in dspy/primitives/module.py
deepcopy() ¶
Deep copy the module.
This is a tweak to the default python deepcopy that only deep copies self.parameters(), and for other attributes, we just do the shallow copy.
Source code in dspy/primitives/base_module.py
dump_state(json_mode=True) ¶
get_lm() ¶
Get the language model used by this module’s predictors.
Returns the language model if every module leaf uses the same LM. Raises an error if multiple different LMs are in use.
Returns:
| Type | Description |
|---|---|
| The language model instance used by this module’s predictors. |
Raises:
| Type | Description |
|---|---|
ValueError | If multiple different language models are being used by the predictors in this module. |
Source code in dspy/primitives/module.py
load(path, allow_pickle=False, allow_unsafe_lm_state=False) ¶
Load the saved module. You may also want to check out dspy.load, if you want to load an entire program, not just the state for an existing program.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path | str | Path to the saved state file, which should be a .json or a .pkl file | required |
allow_pickle | bool | If True, allow loading .pkl files, which can run arbitrary code. This is dangerous and should only be used if you are sure about the source of the file and in a trusted environment. | False |
allow_unsafe_lm_state | bool | If True, preserves unsafe LM endpoint keys (e.g., | False |
Source code in dspy/primitives/base_module.py
load_state(state, *, allow_unsafe_lm_state=False) ¶
Source code in dspy/primitives/base_module.py
named_parameters() ¶
Unlike PyTorch, handles (non-recursive) lists of parameters too.
Source code in dspy/primitives/base_module.py
named_predictors() ¶
Return all named Predict modules in this module.
Iterates through all parameters and returns those that are instances of dspy.Predict, along with their names.
Returns:
| Type | Description |
|---|---|
| list[tuple[str, Predict]]: A list of (name, predictor) tuples where name is the attribute path and predictor is the Predict instance. |
Examples:
>>> import dspy
>>> class MyProgram(dspy.Module):
... def __init__(self):
... super().__init__()
... self.qa = dspy.Predict("question -> answer")
... self.summarize = dspy.Predict("text -> summary")
...
>>> program = MyProgram()
>>> for name, p in program.named_predictors():
... print(name)
qa
summarize
Source code in dspy/primitives/module.py
parameters() ¶
predictors() ¶
Return all Predict modules in this module.
Returns:
| Type | Description |
|---|---|
| list[Predict]: A list of all Predict instances in this module. |
Examples:
>>> import dspy
>>> class MyProgram(dspy.Module):
... def __init__(self):
... super().__init__()
... self.qa = dspy.Predict("question -> answer")
...
>>> program = MyProgram()
>>> len(program.predictors())
1
Source code in dspy/primitives/module.py
reset_copy() ¶
Deep copy the module and reset all parameters.
save(path, save_program=False, modules_to_serialize=None) ¶
Save the module.
Save the module to a directory or a file. There are two modes: - save_program=False: Save only the state of the module to a json or pickle file, based on the value of the file extension. - save_program=True: Save the whole module to a directory via cloudpickle, which contains both the state and architecture of the model.
If save_program=True and modules_to_serialize are provided, it will register those modules for serialization with cloudpickle’s register_pickle_by_value. This causes cloudpickle to serialize the module by value rather than by reference, ensuring the module is fully preserved along with the saved program. This is useful when you have custom modules that need to be serialized alongside your program. If None, then no modules will be registered for serialization.
We also save the dependency versions, so that the loaded model can check if there is a version mismatch on critical dependencies or DSPy version.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path | str | Path to the saved state file, which should be a .json or .pkl file when | required |
save_program | bool | If True, save the whole module to a directory via cloudpickle, otherwise only save the state. | False |
modules_to_serialize | list | A list of modules to serialize with cloudpickle’s | None |
Source code in dspy/primitives/base_module.py
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | |
set_lm(lm) ¶
Set the language model for all predictors in this module.
This method recursively sets the language model on every leaf module in this module.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
lm | The language model instance to use for all predictors. | required |
Examples:
>>> import dspy
>>> lm = dspy.LM("openai/gpt-4o-mini")
>>> program = dspy.Predict("question -> answer")
>>> program.set_lm(lm)