CaraML Docs
CaraML Homepage
  • Introduction
    • What is CaraML?
    • Architecture
      • Feature Store Architecture
      • Models Architecture
      • Routers Architecture
      • Experiments Architecture
      • Pipelines Architecture
    • Core Concepts
      • Models Concepts
      • Router Concepts
      • Experiment Concepts
  • User guides
    • Projects
      • Create a project
      • Managing secrets
    • Feature Store
    • Models
      • Create a Model
        • Custom Model
      • Deploy a Model
        • Deploying a Model Version
        • Severing a Model Version
        • Configuring Transformer
          • Standard Transformer
            • Standard Transformer Expressions
            • Standard Transformer UPI
          • Custom Transformer
        • Redeploying a Model Version
      • Deleting a Model
      • Configuring Alerts
      • Batch Prediction
      • Model Schema
      • Model Observability
    • Routers
      • Creating a Router
        • Configure general settings
        • Configure routes
        • Configure traffic rules
        • Configure autoscaling
        • Configure experiment engine
        • Configure enricher
        • Configure ensembler
        • Configure logging
      • Viewing Routers
        • Configuration
        • History
        • Logs
        • More actions
      • Edit Routers
      • Monitoring router
        • Monitor Router Performance
        • Configure Alerts
      • Undeploying Router
      • Redeploying Router
        • Redeploy undeployed router
        • Redeploy version from history
        • Redeploy version from version details page
      • Deleting Router
        • Deleting router versions
        • Deleting router versions from details page
        • Deleting routers
      • Deleting Emsemblers
        • Delete an Ensembler without related entity
        • Delete an Ensembler with active entities
        • Delete an Ensembler with inactive entities
    • Experiments
      • View Experiment Settings
      • Modify Experiment Settings
      • Creating Experiments
      • Viewing Experiments
      • Modifying Experiments
      • Running Experiments
      • Monitoring Experiments
      • Creating Treatments
      • Viewing Treatments
      • Modifying Treatments
      • Creating Segments
      • Viewing Segments
      • Modifying Segments
      • Creating Custom Segmenters
      • Viewing Custom Segmenters
      • Modifying Custom Segmenters
    • Pipelines
  • Tutorial and Examples
    • Model Sample Notebooks
      • Deploy Standard Models
      • Deploy PyFunc Model
      • Using Transformers
      • Run Batch Prediction Job
      • Others examples on Models
    • Router Examples
    • Feature Store Examples
    • Pipeline Examples
    • Performing load test in CaraML
    • Best practice for CaraML
  • CaraML SDK
    • Feature Store SDK
    • Models SDK
    • Routers SDK
    • Pipeline SDK
  • Troubleshooting and FAQs
    • CaraML System FAQ
    • Models FAQ
      • System Limitations
      • Troubleshooting Deployment Errors
      • E2E Test
    • Routers FAQ
    • Experiments FAQ
    • Feature Store FAQ
    • Pipelines FAQ
    • CaraML Error Messages
  • Deployment Guide
    • Deploying CaraML
      • Local Development
    • Monitoring and alerting
      • Configure a monitoring backend
      • Configure an alerting backend
    • Prerequisites and Dependencies
    • System Benchmark results
    • Experiment Treatment Service
  • Release Notes
    • CaraML Release Notes
Powered by GitBook
On this page
  • Deploy PyFunc Model
  • Deploy PyFunc Model with Custom Prometheus Metrics
  1. Tutorial and Examples
  2. Model Sample Notebooks

Deploy PyFunc Model

PreviousDeploy Standard ModelsNextUsing Transformers

Last updated 1 year ago

Try out the notebooks below to learn how to deploy PyFunc Models to Merlin.

Note on compatibility: The Pyfunc servers are compatible with protobuf>=3.12.0,<5.0.0. Users whose models have a strong dependency on Protobuf 3.x.x are advised to pin the library version in their conda environment, when submitting the model version. If using Protobuf 3.x.x, users can do one of the following:

  • Use protobuf>=3.20.0 - these versions support simplified class definitions and this is the recommended approach.

  • If you must use protobuf>=3.12.0,<3.20.0, other packages used in the Pyfunc server need to be downgraded as well. Please pin the following in your model’s conda environment:

dependencies:
  - pip:
      - protobuf==3.15.6 # Example older protobuf version
      - caraml-upi-protos<=0.3.6
      - grpcio<1.49.0
      - grpcio-reflection<1.49.0
      - grpcio-health-checking<1.49.0

Deploy PyFunc Model

Deploy PyFunc Model with Custom Prometheus Metrics

Logomerlin/Pyfunc.ipynb at main · caraml-dev/merlinGitHub
Logomerlin/Metrics.ipynb at main · caraml-dev/merlinGitHub