bigml-nodered/prediction.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('prediction', {
  category: 'BigML',
  color: '#454957',
  defaults: {"explain":{"value":false},"vote_counts":{"value":""},"private":{"value":false},"tags":{"value":""},"name":{"value":"prediction","required":true},"reify":{"value":false},"vote_count":{"value":0.5},"missing_strategy":{"value":0},"operating_kind":{"value":null},"category":{"value":0},"webhook":{"value":""},"operating_point":{"value":""},"description":{"value":""}},
  inputs:1,
  outputs:1,
  inputLabels: '[model,input-data]',
  outputLabels: 'prediction',
  icon: 'icon_prediction.png',
  label: function() {
    return this.name || 'Prediction';
  },
  labelStyle: function() {
    return this.name?"bigml_node_label":"";
  },
  });
</script>

<script type="text/x-red" data-template-name="prediction">
      <div class="form-row">
        <label for="node-input-name">
            <i class="icon-tag"></i> Name
        </label>
        <input type=text id=node-input-name  value='prediction'>
    </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-explain">
            <i class="icon-tag"></i> Explain
        </label>
        <input type=checkbox id=node-input-explain  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-missing_strategy">
            <i class="icon-tag"></i> Missing strategy
        </label>
        <select id=node-input-missing_strategy  value='0'><option value=0>Last prediction</option> <option value=1>Proportional</option></select>
    </div>
    <div class="form-row">
        <label for="node-input-operating_kind">
            <i class="icon-tag"></i> Operating kind
        </label>
        <select id=node-input-operating_kind  ><option value=confidence>Confidence</option> <option value=probability>Probability</option> <option value=votes>Votes</option></select>
    </div>
    <div class="form-row">
        <label for="node-input-operating_point">
            <i class="icon-tag"></i> Operating point
        </label>
        <input type=text id=node-input-operating_point placeholder='{ "kind": "probability",
    "positive_class": "Iris-setosa",
    "threshold": 0.42 }' >
    </div>
    <div class="form-row">
        <label for="node-input-private">
            <i class="icon-tag"></i> Private
        </label>
        <input type=checkbox id=node-input-private  value='false'>
    </div>
    <div class="form-row">
        <label for="node-input-vote_count">
            <i class="icon-tag"></i> Vote count
        </label>
        <input type=number step=any id=node-input-vote_count  value='0.5'>
    </div>
    <div class="form-row">
        <label for="node-input-vote_counts">
            <i class="icon-tag"></i> Vote counts
        </label>
        <input type=text id=node-input-vote_counts placeholder='[["Female", 0.3], ["Other", 0.2]]' >
    </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="prediction">

<p>Create BigML Prediction.</p>

<h3>Details</h3>
<p>This node support all inputs defined in
  <a href='https://bigml.com/api/predictions' target=blank>BigML REST
  API</a>. By default, it expects to receive
  a <code>[model,input-data]</code> input (see below for more details) and
  it will output the <code>prediction</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>Explain
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Whether you want to request an explanation for the prediction.</dd>

        <dt>Missing strategy
            <span class="property-type">:select</span>
        </dt>
        <dd>Specifies the method that should be used for the model, ensemble or fusion when a missing split is found.</dd>

        <dt>Operating kind
            <span class="property-type">:select</span>
        </dt>
        <dd>The operating threshold kind corresponding to the confusion matrix to perform the evaluation.</dd>

        <dt>Operating point
            <span class="property-type">:text</span>
        </dt>
        <dd>The specification of an operating point for classification problems.</dd>

        <dt>Private
            <span class="property-type">:boolean</span>
        </dt>
        <dd>Whether you want your output resource to be private or not.</dd>

        <dt>Vote count
            <span class="property-type">:float</span>
        </dt>
        <dd>A number between 0 and 1, the fraction of trees that voted for the predicted class.</dd>

        <dt>Vote counts
            <span class="property-type">:json</span>
        </dt>
        <dd>An array of string-float pairs with each class and the corresponding fraction, between 0 and 1, of trees voting for it as elements.</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>prediction</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>