Splunk® Machine Learning Toolkit


Download manual as PDF

Download topic as PDF

Custom algorithm template

You can use the following custom algorithm template to help get you started.

BaseAlgo class

From base import BaseAlgo.

class CustomAlgoTemplate(BaseAlgo):
    def __init__(self, options):
        # Option checking & initializations here

    def fit(self, df, options):
        # Fit an estimator to df, a pandas DataFrame of the search results

    def partial_fit(self, df, options):
        # Incrementally fit a model

    def apply(self, df, options):
        # Apply a saved model
        # Modify df, a pandas DataFrame of the search results
        return df

    def register_codecs():
        # Add codecs to the codec manager

Using the template above in a search, as in the example below, reflects the input data back to the search.

| fit CustomAlgoTemplate *

These are all described in detail in the $SPLUNK_HOME/etc/apps/Splunk_ML_Toolkit/bin/base.py BaseAlgo class as shown below.


Write a Python algorithm class
Running process and method calling conventions

This documentation applies to the following versions of Splunk® Machine Learning Toolkit: 4.4.0, 4.4.1, 4.4.2, 4.5.0, 5.0.0

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters