bigml-nodered/anomaly.html

BigML bindings for Nodered

<style>
.bigml_node_label { fill: white; }
#palette-BigML .palette_node { color: white; }
#red-ui-palette-BigML .red-ui-palette-label { color: white; }
</style>

<script type="text/javascript">
  
  RED.nodes.registerType('anomaly', {
  category: 'BigML',
  color: '#454957',
  defaults: {"default_numeric_value":{"value":"none"},"id_fields":{"value":""},"range":{"value":0},"constraints":{"value":false},"replacement":{"value":false},"tags":{"value":""},"anomaly_seed":{"value":""},"name":{"value":"anomaly","required":true},"top_n":{"value":10},"reify":{"value":false},"seed":{"value":""},"excluded_fields":{"value":""},"forest_size":{"value":128},"normalize_repeats":{"value":false},"fields":{"value":""},"category":{"value":0},"webhook":{"value":""},"out_of_bag":{"value":false},"description":{"value":""},"sample_rate":{"value":1.0},"input_fields":{"value":""}},
  inputs:1,
  outputs:1,
  inputLabels: 'dataset',
  outputLabels: 'anomaly',
  icon: 'icon_anomaly.png',
  label: function() {
    return this.name || 'Anomaly';
  },
  labelStyle: function() {
    return this.name?"bigml_node_label":"";
  },
  });
</script>

<script type="text/x-red" data-template-name="anomaly">
      <div class="form-row">
        <label for="node-input-name">
            <i class="icon-tag"></i> Name
        </label>
        <input type=text id=node-input-name  value='anomaly'>
    </div>
    <div class="form-row">
        <label for="node-input-description">
            <i class="icon-tag"></i> Description
        </label>
        <input type=text id=node-input-description  >
    </div>
    <div class="form-row">
        <label for="node-input-anomaly_seed">
            <i class="icon-tag"></i> Anomaly seed
        </label>
        <input type=text id=node-input-anomaly_seed placeholder='My Seed' >
    </div>
    <div class="form-row">
        <label for="node-input-constraints">
            <i class="icon-tag"></i> Constraints
        </label>
        <input type=checkbox id=node-input-constraints  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-default_numeric_value">
            <i class="icon-tag"></i> Default numeric value
        </label>
        <select id=node-input-default_numeric_value  value='none'><option value=none>None</option> <option value=mean>Mean</option> <option value=median>Median</option> <option value=minimum>Minimum</option> <option value=maximum>Maximum</option> <option value=zero>Zero</option></select>
    </div>
    <div class="form-row">
        <label for="node-input-excluded_fields">
            <i class="icon-tag"></i> Excluded fields
        </label>
        <input type=text id=node-input-excluded_fields placeholder='["000000", "000002"]' >
    </div>
    <div class="form-row">
        <label for="node-input-fields">
            <i class="icon-tag"></i> Fields
        </label>
        <input type=text id=node-input-fields placeholder='{ "000000": { "name": "length_1", "label": "Length 1", "description": "Length 1 is sepal length"}, "000002": {"name": "length_2"}}' >
    </div>
    <div class="form-row">
        <label for="node-input-forest_size">
            <i class="icon-tag"></i> Forest size
        </label>
        <input type=number id=node-input-forest_size  value='128'>
    </div>
    <div class="form-row">
        <label for="node-input-id_fields">
            <i class="icon-tag"></i> ID Fields
        </label>
        <input type=text id=node-input-id_fields placeholder='["000001", "000003"]' >
    </div>
    <div class="form-row">
        <label for="node-input-input_fields">
            <i class="icon-tag"></i> Input fields
        </label>
        <input type=text id=node-input-input_fields placeholder='["000000", "000003"]' >
    </div>
    <div class="form-row">
        <label for="node-input-normalize_repeats">
            <i class="icon-tag"></i> Normalize repeats
        </label>
        <input type=checkbox id=node-input-normalize_repeats  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-out_of_bag">
            <i class="icon-tag"></i> Out of bag
        </label>
        <input type=checkbox id=node-input-out_of_bag  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-range">
            <i class="icon-tag"></i> Range
        </label>
        <input type=number id=node-input-range  value='0'>
    </div>
    <div class="form-row">
        <label for="node-input-replacement">
            <i class="icon-tag"></i> Replacement
        </label>
        <input type=checkbox id=node-input-replacement  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-sample_rate">
            <i class="icon-tag"></i> Sample rate
        </label>
        <input type=number step=any id=node-input-sample_rate  value='1.0'>
    </div>
    <div class="form-row">
        <label for="node-input-seed">
            <i class="icon-tag"></i> Seed
        </label>
        <input type=text id=node-input-seed  >
    </div>
    <div class="form-row">
        <label for="node-input-top_n">
            <i class="icon-tag"></i> Top N
        </label>
        <input type=number id=node-input-top_n  value='10'>
    </div>
    <div class="form-row">
        <label for="node-input-tags">
            <i class="icon-tag"></i> Tags
        </label>
        <input type=text id=node-input-tags placeholder='["A tag", "Another Tag"]' >
    </div>
    <div class="form-row">
        <label for="node-input-category">
            <i class="icon-tag"></i> Category
        </label>
        <select id=node-input-category  value='0'><option value=5>5</option> <option value=Healthcare>Healthcare</option></select>
    </div>
    <div class="form-row">
        <label for="node-input-webhook">
            <i class="icon-tag"></i> Webhook
        </label>
        <input type=text id=node-input-webhook  >
    </div>
    <div class="form-row">
        <label for="node-input-reify">
            <i class="icon-tag"></i> Reify
        </label>
        <input type=checkbox id=node-input-reify  value='false'>
    </div>
</script>

<script type="text/html" data-help-name="anomaly">

<p>Create BigML Anomaly.</p>

<h3>Details</h3>
<p>This node support all inputs defined in
  <a href='https://bigml.com/api/anomalys' target=blank>BigML REST
  API</a>. By default, it expects to receive
  a <code>dataset</code> input (see below for more details) and
  it will output the <code>anomaly</code> field of the created
  resource.
</p>
<p>However, you can override default inputs and outputs by defining
  the node port label so they match the desired input or output as
  specified below.</p>
<p>Only when the node is used with the <code>reify</code> option
  enabled, it will actually hit BigML and do its work there. This
  generally means some resources will be created and sent through as
  node outputs.</p>
<p>When the node is used with the <code>reify</code>option disabled,
  it will generate WhizzML code and send it through to the next node
  in the flow without hitting BigML. All WhizzML code created by this
  node (and others) when not in <code>reify</code> mode is accumulated
  and executed as a single WhizzML script by the first
  downstream <code>reified</code> node.</p>

<h3>Inputs</h3>
    <dl class="message-properties">
            <dt>Name
            <span class="property-type">:text</span>
        </dt>
        <dd>A name for this node.</dd>

        <dt>Description
            <span class="property-type">:text</span>
        </dt>
        <dd></dd>

        <dt>Anomaly seed
            <span class="property-type">:text</span>
        </dt>
        <dd>A string to generate deterministic anomaly detectors.</dd>

        <dt>Constraints
            <span class="property-type">:boolean</span>
        </dt>
        <dd>An experimental option which adds more predicates to each node in the tree.</dd>

        <dt>Default numeric value
            <span class="property-type">:select</span>
        </dt>
        <dd>Substitute missing numeric values across all the numeric fields in the dataset.</dd>

        <dt>Excluded fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Specifies the fields that won't be included in the dataset.</dd>

        <dt>Fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Updates the names, labels, and descriptions of the fields in the dataset.</dd>

        <dt>Forest size
            <span class="property-type">:number</span>
        </dt>
        <dd>The number of trees used by the anomaly detector.</dd>

        <dt>ID Fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Specifies the ids for fields which will be included when computing the top anomalies, but will not be considered to create the anomaly detector.</dd>

        <dt>Input fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Specifies the fields to be included in the dataset.</dd>

        <dt>Normalize repeats
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Controls whether the frequency of repeated (or very similar) data points lower the anomaly score of the repeats.</dd>

        <dt>Out of bag
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Setting this parameter to true will return a sequence of the out-of-bag instances instead of the sampled instances.</dd>

        <dt>Range
            <span class="property-type">:number</span>
        </dt>
        <dd>The range of successive instances to build the model.</dd>

        <dt>Replacement
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Whether sampling should be performed with or without replacement.</dd>

        <dt>Sample rate
            <span class="property-type">:float</span>
        </dt>
        <dd>A real number between 0 and 1 specifying the sample rate.</dd>

        <dt>Seed
            <span class="property-type">:text</span>
        </dt>
        <dd>A string to be hashed to generate deterministic samples.</dd>

        <dt>Top N
            <span class="property-type">:number</span>
        </dt>
        <dd>The number of instances that will be returned together with the anomaly detector that were scored as most anomalous.</dd>

        <dt>Tags
            <span class="property-type">:text</span>
        </dt>
        <dd>A list of tags to identify the resource.</dd>

        <dt>Category
            <span class="property-type">:select</span>
        </dt>
        <dd></dd>

        <dt>Webhook
            <span class="property-type">:text</span>
        </dt>
        <dd>A webhook url and an optional secret phrase.</dd>

        <dt>Reify
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Execute the WhizzML code generated at this (and upstream) node(s). You need to enable this option if you want to get a result from your flow that you can pass to a non-BigML node.</dd>

    </dl>

<h3>Outputs</h3>
     <ol class="node-ports">
             <dl class="message-properties">
                 <dt>payload <span class="property-type">string or
                 JSON</span></dt>
                 <dd>the <code>anomaly</code> of the created
                 BigML entity.</dd>
                 <dt>whizzml <span class="property-type">string</dt>
                 <dd>(only for <code>reified</code> nodes) the
                 generated WhizzML code which is fed into the next
                 node.
                 <dt>wzStack <span class="property-type">object</dt>
                 <dd>(only for <code>reified</code> nodes) private.
             </dl>
     </ol>

</script>