mlflow.dspy

mlflow.dspy.get_default_conda_env()[source]

Returns: The default Conda environment for MLflow Models produced by calls to save_model() and log_model().

mlflow.dspy.get_default_pip_requirements()[source]

Returns: A list of default pip requirements for MLflow Models produced by Dspy flavor. Calls to save_model() and log_model() produce a pip environment that, at minimum, contains these requirements.

mlflow.dspy.load_model(model_uri, dst_path=None)[source]

Note

Experimental: This function may change or be removed in a future release without warning.

Load a Dspy model from a run.

This function will also set the global dspy settings dspy.settings by the saved settings.

Parameters

model_uri –
The location, in URI format, of the MLflow model. For example:
- /Users/me/path/to/local/model
- relative/path/to/local/model
- s3://my_bucket/path/to/model
- runs:/<mlflow_run_id>/run-relative/path/to/model
- mlflow-artifacts:/path/to/model
For more information about supported URI schemes, see Referencing Artifacts.
dst_path – The local filesystem path to utilize for downloading the model artifact. This directory must already exist if provided. If unspecified, a local output path will be created.

Returns

An dspy.module instance, representing the dspy model.

mlflow.dspy.log_model(dspy_model, artifact_path: str, task: Optional[str] = None, model_config: Optional[Dict[str, Any]] = None, code_paths: Optional[List[str]] = None, conda_env: Optional[Union[List[str], str]] = None, signature: Optional[mlflow.models.signature.ModelSignature] = None, input_example: Optional[Union[pandas.core.frame.DataFrame, numpy.ndarray, dict, list, csr_matrix, csc_matrix, str, bytes, tuple]] = None, registered_model_name: Optional[str] = None, await_registration_for: int = 300, pip_requirements: Optional[Union[List[str], str]] = None, extra_pip_requirements: Optional[Union[List[str], str]] = None, metadata: Optional[Dict[str, Any]] = None, resources: Optional[Union[str, pathlib.Path, List[mlflow.models.resources.Resource]]] = None)[source]

Note

Experimental: This function may change or be removed in a future release without warning.

Log a Dspy model along with metadata to MLflow.

This method saves a Dspy model along with metadata such as model signature and conda environments to MLflow.

Parameters

dspy_model – an instance of dspy.Module. The Dspy model to be saved.
artifact_path – the run-relative path to which to log model artifacts.
task – defaults to None. The task type of the model. Can only be llm/v1/chat or None for now.
model_config – keyword arguments to be passed to the Dspy Module at instantiation.
code_paths –
A list of local filesystem paths to Python file dependencies (or directories containing file dependencies). These files are prepended to the system path when the model is loaded. Files declared as dependencies for a given model should have relative imports declared from a common root path if multiple files are defined with import dependencies between them to avoid import errors when loading the model.

For a detailed explanation of code_paths functionality, recommended usage patterns and limitations, see the code_paths usage guide.
conda_env –
Either a dictionary representation of a Conda environment or the path to a conda environment yaml file. If provided, this describes the environment this model should be run in. At a minimum, it should specify the dependencies contained in get_default_conda_env(). If None, a conda environment with pip requirements inferred by mlflow.models.infer_pip_requirements() is added to the model. If the requirement inference fails, it falls back to using get_default_pip_requirements(). pip requirements from conda_env are written to a pip requirements.txt file and the full conda environment is written to conda.yaml. The following is an example dictionary representation of a conda environment:
```
{
    "name": "mlflow-env",
    "channels": ["conda-forge"],
    "dependencies": [
        "python=3.8.15",
        {
            "pip": [
                "dspy==x.y.z"
            ],
        },
    ],
}
```
signature –
an instance of the ModelSignature class that describes the model’s inputs and outputs. If not specified but an input_example is supplied, a signature will be automatically inferred based on the supplied input example and model. To disable automatic signature inference when providing an input example, set signature to False. To manually infer a model signature, call infer_signature() on datasets with valid model inputs, such as a training dataset with the target column omitted, and valid model outputs, like model predictions made on the training dataset, for example:
```
from mlflow.models import infer_signature

train = df.drop_column("target_label")
predictions = ...  # compute model predictions
signature = infer_signature(train, predictions)
```
input_example – one or several instances of valid model input. The input example is used as a hint of what data to feed the model. It will be converted to a Pandas DataFrame and then serialized to json using the Pandas split-oriented format, or a numpy array where the example will be serialized to json by converting it to a list. Bytes are base64-encoded. When the signature parameter is None, the input example is used to infer a model signature.
registered_model_name – defaults to None. If set, create a model version under registered_model_name, also create a registered model if one with the given name does not exist.
await_registration_for – defaults to mlflow.tracking._model_registry.DEFAULT_AWAIT_MAX_SLEEP_SECONDS. Number of seconds to wait for the model version to finish being created and is in READY status. By default, the function waits for five minutes. Specify 0 or None to skip waiting.
pip_requirements – Either an iterable of pip requirement strings (e.g. ["dspy", "-r requirements.txt", "-c constraints.txt"]) or the string path to a pip requirements file on the local filesystem (e.g. "requirements.txt"). If provided, this describes the environment this model should be run in. If None, a default list of requirements is inferred by mlflow.models.infer_pip_requirements() from the current software environment. If the requirement inference fails, it falls back to using get_default_pip_requirements(). Both requirements and constraints are automatically parsed and written to requirements.txt and constraints.txt files, respectively, and stored as part of the model. Requirements are also written to the pip section of the model’s conda environment (conda.yaml) file.
extra_pip_requirements –
Either an iterable of pip requirement strings (e.g. ["pandas", "-r requirements.txt", "-c constraints.txt"]) or the string path to a pip requirements file on the local filesystem (e.g. "requirements.txt"). If provided, this describes additional pip requirements that are appended to a default set of pip requirements generated automatically based on the user’s current software environment. Both requirements and constraints are automatically parsed and written to requirements.txt and constraints.txt files, respectively, and stored as part of the model. Requirements are also written to the pip section of the model’s conda environment (conda.yaml) file.
Warning

The following arguments can’t be specified at the same time:
- conda_env
- pip_requirements
- extra_pip_requirements
This example demonstrates how to specify pip requirements using pip_requirements and extra_pip_requirements.
metadata – Custom metadata dictionary passed to the model and stored in the MLmodel file.
resources – A list of model resources or a resources.yaml file containing a list of resources required to serve the model.

Example

import dspy
import mlflow
from mlflow.models import ModelSignature
from mlflow.types.schema import ColSpec, Schema

# Set up the LM.
lm = dspy.LM(model="openai/gpt-4o-mini", max_tokens=250)
dspy.settings.configure(lm=lm)


class CoT(dspy.Module):
    def __init__(self):
        super().__init__()
        self.prog = dspy.ChainOfThought("question -> answer")

    def forward(self, question):
        return self.prog(question=question)


dspy_model = CoT()

mlflow.set_tracking_uri("http://127.0.0.1:5000")
mlflow.set_experiment("test-dspy-logging")

from mlflow.dspy import log_model

input_schema = Schema([ColSpec("string")])
output_schema = Schema([ColSpec("string")])
signature = ModelSignature(inputs=input_schema, outputs=output_schema)

with mlflow.start_run():
    log_model(
        dspy_model,
        "model",
        input_example="what is 2 + 2?",
        signature=signature,
    )

mlflow.dspy.save_model(model, path: str, task: Optional[str] = None, model_config: Optional[Dict[str, Any]] = None, code_paths: Optional[List[str]] = None, mlflow_model: Optional[mlflow.models.model.Model] = None, conda_env: Optional[Union[List[str], str]] = None, signature: Optional[mlflow.models.signature.ModelSignature] = None, input_example: Optional[Union[pandas.core.frame.DataFrame, numpy.ndarray, dict, list, csr_matrix, csc_matrix, str, bytes, tuple]] = None, pip_requirements: Optional[Union[List[str], str]] = None, extra_pip_requirements: Optional[Union[List[str], str]] = None, metadata: Optional[Dict[str, Any]] = None, resources: Optional[Union[str, pathlib.Path, List[mlflow.models.resources.Resource]]] = None)[source]

Note

Experimental: This function may change or be removed in a future release without warning.

Save a Dspy model.

This method saves a Dspy model along with metadata such as model signature and conda environments to local file system. This method is called inside mlflow.dspy.log_model().

Parameters

model – an instance of dspy.Module. The Dspy model/module to be saved.
path – local path where the MLflow model is to be saved.
task – defaults to None. The task type of the model. Can only be llm/v1/chat or None for now.
model_config – keyword arguments to be passed to the Dspy Module at instantiation.
code_paths –
A list of local filesystem paths to Python file dependencies (or directories containing file dependencies). These files are prepended to the system path when the model is loaded. Files declared as dependencies for a given model should have relative imports declared from a common root path if multiple files are defined with import dependencies between them to avoid import errors when loading the model.

For a detailed explanation of code_paths functionality, recommended usage patterns and limitations, see the code_paths usage guide.
mlflow_model – an instance of mlflow.models.Model, defaults to None. MLflow model configuration to which to add the Dspy model metadata. If None, a blank instance will be created.
conda_env –
Either a dictionary representation of a Conda environment or the path to a conda environment yaml file. If provided, this describes the environment this model should be run in. At a minimum, it should specify the dependencies contained in get_default_conda_env(). If None, a conda environment with pip requirements inferred by mlflow.models.infer_pip_requirements() is added to the model. If the requirement inference fails, it falls back to using get_default_pip_requirements(). pip requirements from conda_env are written to a pip requirements.txt file and the full conda environment is written to conda.yaml. The following is an example dictionary representation of a conda environment:
```
{
    "name": "mlflow-env",
    "channels": ["conda-forge"],
    "dependencies": [
        "python=3.8.15",
        {
            "pip": [
                "dspy==x.y.z"
            ],
        },
    ],
}
```
signature –
an instance of the ModelSignature class that describes the model’s inputs and outputs. If not specified but an input_example is supplied, a signature will be automatically inferred based on the supplied input example and model. To disable automatic signature inference when providing an input example, set signature to False. To manually infer a model signature, call infer_signature() on datasets with valid model inputs, such as a training dataset with the target column omitted, and valid model outputs, like model predictions made on the training dataset, for example:
```
from mlflow.models import infer_signature

train = df.drop_column("target_label")
predictions = ...  # compute model predictions
signature = infer_signature(train, predictions)
```
input_example – one or several instances of valid model input. The input example is used as a hint of what data to feed the model. It will be converted to a Pandas DataFrame and then serialized to json using the Pandas split-oriented format, or a numpy array where the example will be serialized to json by converting it to a list. Bytes are base64-encoded. When the signature parameter is None, the input example is used to infer a model signature.
pip_requirements – Either an iterable of pip requirement strings (e.g. ["dspy", "-r requirements.txt", "-c constraints.txt"]) or the string path to a pip requirements file on the local filesystem (e.g. "requirements.txt"). If provided, this describes the environment this model should be run in. If None, a default list of requirements is inferred by mlflow.models.infer_pip_requirements() from the current software environment. If the requirement inference fails, it falls back to using get_default_pip_requirements(). Both requirements and constraints are automatically parsed and written to requirements.txt and constraints.txt files, respectively, and stored as part of the model. Requirements are also written to the pip section of the model’s conda environment (conda.yaml) file.
extra_pip_requirements –
Either an iterable of pip requirement strings (e.g. ["pandas", "-r requirements.txt", "-c constraints.txt"]) or the string path to a pip requirements file on the local filesystem (e.g. "requirements.txt"). If provided, this describes additional pip requirements that are appended to a default set of pip requirements generated automatically based on the user’s current software environment. Both requirements and constraints are automatically parsed and written to requirements.txt and constraints.txt files, respectively, and stored as part of the model. Requirements are also written to the pip section of the model’s conda environment (conda.yaml) file.
Warning

The following arguments can’t be specified at the same time:
- conda_env
- pip_requirements
- extra_pip_requirements
This example demonstrates how to specify pip requirements using pip_requirements and extra_pip_requirements.
metadata – Custom metadata dictionary passed to the model and stored in the MLmodel file.
resources – A list of model resources or a resources.yaml file containing a list of resources required to serve the model.