update documentation

Author: yllieth

Gruntfile.js

@@ -57,7 +57,7 @@ module.exports = function(grunt) {
     ngdocs: {
       options: {
         dest: 'docs/',
-        title: 'ML | SDK: Documentation',
+        title: 'jsSDK: Documentation',
         //scripts: ['vendor/angular/angular.js'],
         styles: ['docs/ngdoc.css'],
         html5Mode: false,

docs/index.html

@@ -11,7 +11,7 @@
                  Declarative templates with data-binding, MVC, dependency injection and great
                  testability story all implemented with pure client-side JavaScript!">
   <meta name="fragment" content="!">
-  <title ng-bind-template="ML | SDK: Documentation: {{partialTitle}}">Docs</title>
+  <title ng-bind-template="jsSDK: Documentation: {{partialTitle}}">Docs</title>
   <script type="text/javascript">
     // dynamically add base tag as well as css and javascript files.
     // we can't add css/js the usual way, because some browsers (FF) eagerly prefetch resources
@@ -92,7 +92,7 @@
         <div class="container">
 
 
-            <a  href="/api"  class="brand">ML | SDK: Documentation</a>
+            <a  href="/api"  class="brand">jsSDK: Documentation</a>
 
           <ul class="nav">
             <li ng-repeat="(url, name) in sections" ng-class="{active: isActivePath(url)}">

docs/js/docs-setup.js

@@ -18,7 +18,7 @@ NG_DOCS={
       "shortName": "predicsis.jsSDK.helpers.jobsHelper",
       "type": "service",
       "moduleName": "predicsis.jsSDK.helpers",
-      "keywords": "$q active alt api array async asynchronous check completed completely completly consider coul created current dataset example fulfilled function going hasn helpers http https job jobid jobs jobshelper jssdk list listen listened lot minute notes params pending png position post predicsis promise property pulling request requests resolved resolving resource response return returns schema second send service src standard succeeds termination time transform usage values wait waiting workflow wrapasyncpromise"
+      "keywords": "$q active alt api array async asynchronous callback called check completed completely completly consider coul created current dataset error example fulfilled function going handler hasn helpers http https job jobid jobs jobshelper jssdk list listen listened lot minute notes occuring occurs params pending png position post predicsis promise property pulling request requests resolved resolving resource response return returns schema second send service set seterrorhandler src standard succeeds termination time transform usage values wait waiting workflow wrapasyncpromise"
     },
     {
       "section": "api",

docs/partials/api/predicsis.jsSDK.helpers.datasetHelper.html

@@ -1,4 +1,4 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/datasetHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L6" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">datasetHelper</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/datasetHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L6" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">datasetHelper</code>
 <div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
@@ -7,33 +7,33 @@
 <div class="description"><div class="predicsis-jssdk-helpers-datasethelper-page"><p>Give some utility method on a <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a> object</p>
 </div></div>
 <div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L18" class="view-source icon-eye-open"> </a><h3 id="methods_haschildren">hasChildren(dataset)</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L18" class="view-source icon-eye-open"> </a><h3 id="methods_haschildren">hasChildren(dataset)</h3>
 <div class="haschildren"><div class="haschildren-page"><p>Tells if a dataset has subsets</p>
 </div><h5 id="methods_haschildren_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="haschildren-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
 </div></td></tr></tbody></table><h5 id="methods_haschildren_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="haschildren-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L44" class="view-source icon-eye-open"> </a><h3 id="methods_ischil">isChil(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L44" class="view-source icon-eye-open"> </a><h3 id="methods_ischil">isChil(dataset)</h3>
 <div class="ischil"><div class="ischil-page"><p>Tells if a dataset is a child dataset
 <b>Note:</b> A dataset is considered as a child if it has a parent. There is no orphan among datasets!</p>
 </div><h5 id="methods_ischil_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="ischil-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
 </div></td></tr></tbody></table><h5 id="methods_ischil_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="ischil-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L82" class="view-source icon-eye-open"> </a><h3 id="methods_isformatted">isFormatted(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L82" class="view-source icon-eye-open"> </a><h3 id="methods_isformatted">isFormatted(dataset)</h3>
 <div class="isformatted"><div class="isformatted-page"><p>Tells if a dataset has both header and separator defined.</p>
 </div><h5 id="methods_isformatted_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="isformatted-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
 </div></td></tr></tbody></table><h5 id="methods_isformatted_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="isformatted-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L31" class="view-source icon-eye-open"> </a><h3 id="methods_isparent">isParent(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L31" class="view-source icon-eye-open"> </a><h3 id="methods_isparent">isParent(dataset)</h3>
 <div class="isparent"><div class="isparent-page"><p>Tells if a dataset is a parent dataset.
 <b>Note:</b> A parent may have any children, but its <kbd>parent_dataset_id</kbd> must be null</p>
 </div><h5 id="methods_isparent_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="isparent-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
 </div></td></tr></tbody></table><h5 id="methods_isparent_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="isparent-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L101" class="view-source icon-eye-open"> </a><h3 id="methods_isscore">isScore(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L101" class="view-source icon-eye-open"> </a><h3 id="methods_isscore">isScore(dataset)</h3>
 <div class="isscore"><div class="isscore-page"><p>Tells if a dataset is the result of a score.
 A score result is identified by the following rules:</p>
 <ul>
@@ -45,14 +45,14 @@
 </div></td></tr></tbody></table><h5 id="methods_isscore_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="isscore-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L70" class="view-source icon-eye-open"> </a><h3 id="methods_istestpart">isTestPart(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L70" class="view-source icon-eye-open"> </a><h3 id="methods_istestpart">isTestPart(dataset)</h3>
 <div class="istestpart"><div class="istestpart-page"><p>Tells if a dataset is a train subset.
 <b>Note:</b> A dataset is considered as a test subset if its sampling is negative</p>
 </div><h5 id="methods_istestpart_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="istestpart-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
 </div></td></tr></tbody></table><h5 id="methods_istestpart_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="istestpart-page"><p><kbd>true</kbd> / <kbd>false</kbd></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/datasetHelper.js#L57" class="view-source icon-eye-open"> </a><h3 id="methods_istrainpart">isTrainPart(dataset)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/datasetHelper.js#L57" class="view-source icon-eye-open"> </a><h3 id="methods_istrainpart">isTrainPart(dataset)</h3>
 <div class="istrainpart"><div class="istrainpart-page"><p>Tells if a dataset is a train subset.
 <b>Note:</b> A dataset is considered as a train subset if its sampling is positive</p>
 </div><h5 id="methods_istrainpart_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>dataset</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="istrainpart-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>

docs/partials/api/predicsis.jsSDK.helpers.jobsHelper.html

@@ -1,10 +1,10 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/jobsHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/jobsHelper.js#L25" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">jobsHelper</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/jobsHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/jobsHelper.js#L25" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">jobsHelper</code>
 <div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
 </h1>
 <div><div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/jobsHelper.js#L47" class="view-source icon-eye-open"> </a><h3 id="methods_listen">listen(jobId)</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/jobsHelper.js#L47" class="view-source icon-eye-open"> </a><h3 id="methods_listen">listen(jobId)</h3>
 <div class="listen"><div class="listen-page"><p>Active pulling on a job waiting for its termination</p>
 <p><b>Important notes:</b></p>
 <ul>
@@ -14,7 +14,20 @@
 </div></td></tr></tbody></table><h5 id="methods_listen_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-promise">Promise</a></td><td><div class="listen-page"><p>A promise resolved only when the job succeeds</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/jobsHelper.js#L120" class="view-source icon-eye-open"> </a><h3 id="methods_wrapasyncpromise">wrapAsyncPromise(promise)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/jobsHelper.js#L153" class="view-source icon-eye-open"> </a><h3 id="methods_seterrorhandler">setErrorHandler(callback)</h3>
+<div class="seterrorhandler"><div class="seterrorhandler-page"><p>set error handler (errors occuring in a job)</p>
+<p>Usage example:
+<pre class="prettyprint linenums">
+return jobsHelper
+  .setErrorHandler(function(error) {
+    // do something with error
+    // ...
+  });
+</pre>
+</div><h5 id="methods_seterrorhandler_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>callback</td><td><a href="" class="label type-hint type-hint-function">Function</a></td><td><div class="seterrorhandler-page"><p>called when an error occurs during a Job</p>
+</div></td></tr></tbody></table></div>
+</li>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/jobsHelper.js#L120" class="view-source icon-eye-open"> </a><h3 id="methods_wrapasyncpromise">wrapAsyncPromise(promise)</h3>
 <div class="wrapasyncpromise"><div class="wrapasyncpromise-page"><p>Transform an async promise into the same promise resolving only when job is completed</p>
 <p>Usage example:
 <pre class="prettyprint linenums">

docs/partials/api/predicsis.jsSDK.helpers.modelHelper.html

@@ -1,4 +1,4 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/modelHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/modelHelper.js#L13" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">modelHelper</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/modelHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/modelHelper.js#L13" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">modelHelper</code>
 <div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
@@ -17,7 +17,7 @@
 </div></li>
 </ul>
 <div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/d47b9e6/lib/helper/modelHelper.js#L62" class="view-source icon-eye-open"> </a><h3 id="methods_learn">learn(project)</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/6972c81/lib/helper/modelHelper.js#L62" class="view-source icon-eye-open"> </a><h3 id="methods_learn">learn(project)</h3>
 <div class="learn"><div class="learn-page"><p>Learn a model</p>
 <p>This function wraps the following requests:</p>
 <ul>