Splunk® Machine Learning Toolkit

User Guide

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of Splunk® Machine Learning Toolkit. For documentation on the most recent version, go to the latest release.
Acrobat logo Download topic as PDF

Detect Categorical Outliers Experiment workflow

Experiments manage the data source, algorithm, and the parameters to configure that algorithm within one framework. An Experiment is an exclusive knowledge object in the Splunk platform that keeps track of its settings and history, as well as its affiliated alerts and scheduled trainings. Experiment Assistants enable machine learning through a guided user interface.

The Detect Categorical Outliers Experiment Assistant identifies data that indicate interesting or unusual events. This Assistant allows non-numeric and multi-dimensional data, such as string identifiers and IP addresses. To detect categorical outliers, input data and select the fields for which to look for unusual combinations or a coincidence of rare values. When multiple fields have rare values, the result is an outlier.

The following image illustrates results from the showcase example in the Splunk Machine Learning Toolkit with Bitcoin data.

This image shows the number of categorical outliers and a corresponding table with user information from bitcoin transactions.

Algorithm

The Detect Categorical Outliers Assistant uses the following algorithm:

  • Probabilistic measures

Detect Categorical Outliers

To detect categorical outliers, input data and select the fields to analyze.

Workflow

Follow these steps to create a Detect Categorical Outliers Experiment.

  1. From the MLTK navigation bar, click Experiments.
    • If this is the first Experiment in the toolkit, you will land on a display screen of all six assistants. Select the Detect Categorical Outliers block.
    • If you have at least one Experiment in the toolkit, you will land on a list view of Experiments. Click the Create New Experiment button.
  2. Fill in an Experiment Title, and add a description. Both the name and description can be edited later if needed.
  3. Click Create.
  4. Run a search, and be sure to select a date range.
  5. Select the fields you want to analyze.

    The list populates every time you run a search.

  6. (Optional) Add notes to this Experiment. Use this free form block of text to track the selections made in the fields above. Refer back to notes to review which parameter combinations yield the best results
  7. Click Detect Outliers. The Experiment is now in a Draft state.
    Draft versions allow you to alter settings without committing or overwriting a saved Experiment. This Experiment is not stored to Splunk until it is saved.
    The following table explains the differences between a draft and a saved Experiment:
    Action Draft Experiment Saved Experiment
    Create new record in Experiment history Yes No
    Run Experiment search jobs Yes No
    (As applicable) Save and update Experiment model No Yes
    (As applicable) Update all Experiment alerts No Yes
    (As applicable) Update Experiment scheduled trainings No Yes

Interpret and validate

After you detect outliers, review your results and the corresponding tables. Results often have a few outliers. You can use the following methods to evaluate detection:

Result Definition
Outliers This result shows the number of events flagged as outliers.
Total Events This result shows the total number of events that were evaluated.
Data and Outliers This table lists the events that marked as outliers, and the corresponding reason that the event is marked as an outlier.

Save the Experiment

Once you are happy with the results of your Experiment, save it. Saving your Experiment will result in the following:

  1. Assistant settings saved as an Experiment knowledge object.
  2. (As applicable) Draft model updated to an Experiment model.
  3. (As applicable) Affiliated scheduled trainings and alerts update to synchronize with the search SPL and trigger conditions.

You can load a saved Experiment by clicking the Experiment name.

Deploy and manage categorical outlier detection

After you interpret and validate the Experiment, deploy the detection.

Within the Experiment framework:

To manage your Experiment, perform the following steps:

  1. From the MLTK navigation bar, choose Experiments. A list of your saved Experiments populates.
  2. Click the Manage button available under the Actions column.

The toolkit supports the following Experiment management options:

  1. Create Experiment-level alerts.
    Updating a saved Experiment can affect affiliated alerts. Re-validate your alerts once you complete the changes.
    For more information about alerts, see Getting started with alerts in the Splunk Enterprise Alerting Manual.
  2. Edit the title and description of the Experiment.
  3. (As applicable) Manage alerts for a single Experiment.
  4. (As applicable) Schedule a training job for an Experiment.
  5. Delete an Experiment.

Experiments are always stored under the user's namespace, meaning that changing sharing settings and permissions on Experiments is not supported.

Outside the Experiment framework

  1. Click Open in Search to generate a New Search tab for this same dataset. This new search opens in a new browser tab, away from the Assistant.
    This search query uses all data, not just the training set. You can adjust the SPL directly and see the results immediately. You can also save the query as a Report, Dashboard Panel or Alert.
  2. Click Show SPL to generate a modal window/ overlay showing the search query that you used to fit the model. Copy the SPL to use in other aspects of your Splunk instance.
Last modified on 11 March, 2019
PREVIOUS
Detect Numeric Outliers Experiment workflow
  NEXT
Forecast Time Series Experiment workflow

This documentation applies to the following versions of Splunk® Machine Learning Toolkit: 3.4.0


Was this documentation topic helpful?


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