Splunk® Machine Learning Toolkit

ML-SPL API Guide

Download manual as PDF

Download topic as PDF

Running process and method calling conventions

Become familiar with Splunk platform logic pertaining to running process and method calling conventions. In particular, the fit, partial_fit, apply, and summary commands.

Fit command when partial_fit is False

When running the fit command and the partial_fit parameter is in the default state of False, the fit method of the chosen algorithm is called first. If that method returns a DataFrame the process returns to the search. If that method does not return a DataFrame, the apply command is called to return a DataFrame.

The default for the partial_fit parameter is False (partial_fit=f).

This image shows a running process diagram for the fit command.

Fit command when partial_fit is True

When running the fit command and the partial_fit parameter is set to True, the partial_fit method of the chosen algorithm is called first on each chunk of 50,000 events. The apply command is then called on those events. This process continues until you run out of events.

This image shows a running process diagram for the partial fit command.

Apply command

When running the apply command, the Python object is reconstructed using its codec. Then the apply command is called on the events, chunk by chunk.

This image shows a running process diagram for the apply command.

Summary command

Similar to running the apply command, when running the summary command, the Python object is reconstructed using its codec. Once done, the summary command is called.

This image shows a running process diagram for the summary command.

PREVIOUS
Custom algorithm template
  NEXT
Using codecs

This documentation applies to the following versions of Splunk® Machine Learning Toolkit: 4.4.0, 4.4.1, 4.4.2, 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