The mlflow.prophet module provides an API for logging and loading Prophet models. This module exports univariate Prophet models in the following flavors:
This is the main flavor that can be accessed with Prophet APIs.
mlflow.pyfunc
Produced for use by generic pyfunc-based deployment tools and for batch auditing of historical forecasts.
The default Conda environment for MLflow Models produced by calls to save_model() and log_model().
A list of default pip requirements for MLflow Models produced by this flavor. Calls to save_model() and log_model() produce a pip environment that, at a minimum, contains these requirements.
Load a Prophet model from a local file or a run.
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
For more information about supported URI schemes, see Referencing Artifacts.
dst_path â The local filesystem path to which to download the model artifact. This directory must already exist. If unspecified, a local output path will be created.
A Prophet model instance
Logs a Prophet model as an MLflow artifact for the current run.
pr_model â Prophet model to be saved.
artifact_path â Deprecated. Use name instead.
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": [
"prophet==x.y.z"
],
},
],
}
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.
registered_model_name â If given, create a model version under registered_model_name, also creating a registered model if one with the given name does not exist.
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 model = Prophet().fit(df) train = model.history predictions = model.predict(model.make_future_dataframe(30)) 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.
await_registration_for â 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. ["prophet", "-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.
name â Model name.
params â A dictionary of parameters to log with the model.
tags â A dictionary of tags to log with the model.
model_type â The type of the model.
step â The step at which to log the model outputs and metrics
model_id â The ID of the model.
A ModelInfo instance that contains the metadata of the logged model.
Save a Prophet model to a path on the local file system.
pr_model â Prophet model (an instance of Prophet() forecaster that has been fit on a temporal series.
path â Local path where the serialized model (as JSON) is to be saved.
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": [
"prophet==x.y.z"
],
},
],
}
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 â mlflow.models.Model this flavor is being added to.
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 model = Prophet().fit(df) train = model.history predictions = model.predict(model.make_future_dataframe(30)) 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. ["prophet", "-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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4