bigml-nodered/cluster.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('cluster', {
  category: 'BigML',
  color: '#454957',
  defaults: {"default_numeric_value":{"value":"none"},"weight_field":{"value":""},"range":{"value":0},"balance_fields":{"value":false},"replacement":{"value":false},"model_clusters":{"value":false},"tags":{"value":""},"summary_fields":{"value":""},"regularization":{"value":null},"field_scales":{"value":""},"name":{"value":"cluster","required":true},"reify":{"value":false},"cluster_seed":{"value":""},"seed":{"value":""},"critical_value":{"value":5},"excluded_fields":{"value":""},"k":{"value":0},"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: 'cluster',
  icon: 'icon_cluster.png',
  label: function() {
    return this.name || 'Cluster';
  },
  labelStyle: function() {
    return this.name?"bigml_node_label":"";
  },
  });
</script>

<script type="text/x-red" data-template-name="cluster">
      <div class="form-row">
        <label for="node-input-name">
            <i class="icon-tag"></i> Name
        </label>
        <input type=text id=node-input-name  value='cluster'>
    </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-balance_fields">
            <i class="icon-tag"></i> Balance fields
        </label>
        <input type=checkbox id=node-input-balance_fields  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-cluster_seed">
            <i class="icon-tag"></i> Cluster seed
        </label>
        <input type=text id=node-input-cluster_seed placeholder='My Seed' >
    </div>
    <div class="form-row">
        <label for="node-input-critical_value">
            <i class="icon-tag"></i> Critical value
        </label>
        <input type=number id=node-input-critical_value  value='5'>
    </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-field_scales">
            <i class="icon-tag"></i> Field scales
        </label>
        <input type=text id=node-input-field_scales placeholder='{
    "000001": 4,
    "000003": 2 }' >
    </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-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-k">
            <i class="icon-tag"></i> K
        </label>
        <input type=number id=node-input-k  value='0'>
    </div>
    <div class="form-row">
        <label for="node-input-model_clusters">
            <i class="icon-tag"></i> Model clusters
        </label>
        <input type=checkbox id=node-input-model_clusters  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-regularization">
            <i class="icon-tag"></i> Regularization
        </label>
        <select id=node-input-regularization  ><option value=l1>L1 norm</option> <option value=l2>L2 norm</option></select>
    </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-summary_fields">
            <i class="icon-tag"></i> Summary fields
        </label>
        <input type=text id=node-input-summary_fields placeholder='["000004"]' >
    </div>
    <div class="form-row">
        <label for="node-input-weight_field">
            <i class="icon-tag"></i> Weight field
        </label>
        <input type=text id=node-input-weight_field  >
    </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="cluster">

<p>Create BigML Cluster.</p>

<h3>Details</h3>
<p>This node support all inputs defined in
  <a href='https://bigml.com/api/clusters' 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>cluster</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>Balance fields
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Whether to scale each numeric field such that its values are zero mean with a standard deviation of 1, based on the field summary statistics at training time.</dd>

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

        <dt>Critical value
            <span class="property-type">:number</span>
        </dt>
        <dd>The clustering algorithm G-means is parameter free except for one, the critical_value parameter.</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>Field scales
            <span class="property-type">:text</span>
        </dt>
        <dd>With this argument you can pick your own scaling for each field.</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>Input fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Specifies the fields to be included in the dataset.</dd>

        <dt>K
            <span class="property-type">:number</span>
        </dt>
        <dd>The number of clusters.</dd>

        <dt>Model clusters
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Whether a model for every cluster will be generated or not.</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>Regularization
            <span class="property-type">:select</span>
        </dt>
        <dd>It selects the norm to minimize when regularizing the solution.</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>Summary fields
            <span class="property-type">:text</span>
        </dt>
        <dd>Specifies the ids for fields which will be included when generating the per cluster summaries/datasets, but will not be used for clustering.</dd>

        <dt>Weight field
            <span class="property-type">:text</span>
        </dt>
        <dd>Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value.</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>cluster</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>