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
  • 0. Create Segmenter
  • 1. Configure Segmenter's General Settings
  1. User guides
  2. Experiments

Creating Custom Segmenters

PreviousModifying SegmentsNextViewing Custom Segmenters

Last updated 2 years ago

From the Settings page, click on the 'Segmenters' tab.

Created segmenters can be used just as global segmenters, but only in the project in which they are created in.

0. Create Segmenter

  1. Click on 'More Actions', followed by the 'Create Segmenter' button on the landing page.

1. Configure Segmenter's General Settings

  1. In the Create Segmenter's general settings page, fill up the given form

    1. Name: Name of segmenter.

    2. Type: Type of the segmenter (string, bool, integer or real).

    3. Description: Description of segmenter.

    4. Required: Indicates whether the segmenter must be selected in experiments.

    5. Multi-Valued: Indicates whether the segmenter has multiple values.

    6. Options: Name-value pairs for the segmenter values. This field needs to be a valid JSON object.

    7. Constraints: Constraints for the segmenter when prerequisite conditions are met.

      1. Pre-Requisite Segmenter Values: An array of objects with the fields segmenter_name and segmenter_values. This field needs to be a valid JSON array.

        1. Segmenter_Name: A string indicating the name of the segmenter. Note that none of the objects specified should have a segmenter_name with the same name as the segmenter that you are creating.

        2. Segmenter Values: An array of segmenter values corresponding to the segmenter.

      2. Allowed Values: An array of allowed segmenter values. Note that the values specified here should form a subset of the values specified in 'Options' and cannot be empty. This field needs to be a valid JSON array.

      3. Values Override: New name-value mappings to overwrite the names for the values under 'Options'. Note that the values specified here should form a subset of the values specified in 'Options'. This field should specify the name-value mappings for each and every value in the allowed values field, and it needs to be a valid JSON object.

  2. Click "Save" to create the Segmenter.

Create Custom Segmenter Navigation
Create Custom Segmenter Landing
Create_Custom_Segmenter General