Register an algorithm

In order to use an algorithm in Splunk Machine Learning Toolkit, you have to register the algorithm in the MLTK app to make it visible to the Splunk platform.

Register the name of an algorithm

To register an algorithm, update the algos.conf file with the name of the algorithm you want to add:

$SPLUNK_HOME/etc/apps/Splunk_ML_Toolkit/local/algos.conf

This can be done using the REST API or by manual file update:

Register an algorithm name using the REST API

$ curl -k -u admin:<admin pass> https://localhost:8089/servicesNS/nobody/Splunk_ML_Toolkit/configs/conf-algos -d name="<Your new algorithm class name>"

Register an algorithm name with a manual file update

1. Create or update algos.conf in the following directory:
   

   $SPLUNK_HOME/etc/apps/Splunk_ML_Toolkit/local

2. Add the algorithm name as a stanza, meaning within brackets, to the algos.conf file:
   Example:
   

   [<Your new algorithm class name>]

3. Click save.
4. Restart Splunk Enterprise.

Implement the algorithm

To implement the algorithm, create and name a python script file (.py file) for the algorithm in:

$SPLUNK_HOME/etc/apps/Splunk_ML_Toolkit/bin/algos

The name of the .py file and the name of the main class in the .py file must be the same as the stanza name, the name in brackets, used in the algos.conf file. For example, [LinearRegression] for the LinearRegression algorithm.

<Your new algorithm class name>.py

The name of the algorithm class must be unique and not conflict with other names in the algos.conf file.