SUMMARY.md

Table of contents

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