add datasetHelper.isScore method

Author: yllieth

dist/predicsis-jsSDK.js

@@ -163,7 +163,7 @@ angular
  * }
  * </pre>
  *
- * <h3>Splitted learning dataset -> learned part</h3>
+ * <h3>Splitted learning dataset -> learned part (see {@link predicsis.jsSDK.helpers.datasetHelper#methods_istrainpart datasetHelper.isTrainPart(Dataset dataset)})</h3>
  * <pre>
  * {
  *   ...
@@ -176,7 +176,7 @@ angular
  * }
  * </pre>
  *
- * <h3>Splitted learning dataset -> tested part</h3>
+ * <h3>Splitted learning dataset -> tested part (see {@link predicsis.jsSDK.helpers.datasetHelper#methods_istestpart datasetHelper.isTestPart(Dataset dataset)})</h3>
  * <pre>
  * {
  *   ...
@@ -216,7 +216,7 @@ angular
  * }
  * </pre>
  *
- * <h3>Scoreset</h3>
+ * <h3>Scoreset (see {@link predicsis.jsSDK.helpers.datasetHelper#methods_isScore datasetHelper.isScore(Dataset dataset)})</h3>
  * <pre>
  * {
  *   ...
@@ -226,6 +226,8 @@ angular
  *   ...
  * }
  * </pre>
+ *
+ * Please also note that there is no distinction between a learning dataset and a scoring dataset.
  */
 angular
   .module('predicsis.jsSDK.models')
@@ -2626,7 +2628,7 @@ angular
      * @return {Boolean} <kbd>true</kbd> / <kbd>false</kbd>
      */
     this.isChild = function(dataset) {
-      return Boolean(dataset.parant_dataset_id !== null);
+      return Boolean(dataset.parent_dataset_id !== null);
     };
 
     /**
@@ -2667,6 +2669,28 @@ angular
       return Boolean(dataset.header !== null) && Boolean(dataset.separator !== null)
     };
 
+    /**
+     * @ngdoc function
+     * @methodOf predicsis.jsSDK.helpers.datasetHelper
+     * @name isScore
+     * @description Tells if a dataset is the result of a score.
+     * A score result is identified by the following rules:
+     * <ul>
+     *   <li><code>dataset.source_ids.length === 0</code></li>
+     *   <li><code>dataset.main_modality !== null</code></li>
+     *   <li><code>dataset.classifier !== null</code></li>
+     *   <li><code>dataset.dataset_id !== null</code></li>
+     * </ul>
+     * @param {Object} dataset Instance of {@link predicsis.jsSDK.models.Datasets dataset}
+     * @return {Boolean} <kbd>true</kbd> / <kbd>false</kbd>
+     */
+    this.isScore = function(dataset) {
+      return Boolean(dataset.source_ids.length === 0)
+        && Boolean(dataset.main_modality !== null)
+        && Boolean(dataset.classifier !== null)
+        && Boolean(dataset.dataset_id !== null);
+    };
+
   });
 
 /**

dist/predicsis-jsSDK.min.js

@@ -10,7 +10,7 @@ NG_DOCS={
       "type": "service",
       "moduleName": "predicsis.jsSDK.helpers",
       "shortDescription": "Give some utility method on a dataset object",
-      "keywords": "api child children considered dataset datasethelper datasets defined function haschildren header helpers instance ischil isformatted isparent istestpart istrainpart jssdk method models negative null object orphan parent positive predicsis sampling separator service subset subsets tells test train utility"
+      "keywords": "api child children classifier considered dataset dataset_id datasethelper datasets defined function haschildren header helpers identified instance ischil isformatted isparent isscore istestpart istrainpart jssdk length main_modality method models negative null object orphan parent positive predicsis result rules sampling score separator service source_ids subset subsets tells test train utility"
     },
     {
       "section": "api",
@@ -51,7 +51,7 @@ NG_DOCS={
       "type": "service",
       "moduleName": "predicsis.jsSDK.models",
       "shortDescription": "",
-      "keywords": "$classifier_id $dataset_id $header $main_modality $modalities_set_id $name $q $separator api async awesome badge build changes children_dataset_ids class classifier_id colspan create created_at creation csv data_file datafile dataset dataset_id dataset_name datasets delete description destroy dictionary dictionary_ids differents documentation escape examples existing fetch file filename filenames function generated_dictionaries_ids generation getchildren going header https identifier job_ids jobshelper jssdk learned learned_learning_dataset learning learning-dataset learning_dataset learning_dataset_with_model list main_modality method methods_all methods_create methods_delete methods_get methods_getchildren methods_split methods_update modalities_set_id model models named nb_of_lines null original original_source_id paradox parameters params parent_dataset_id parent_dictionary patch permanently post predicsis preview ratio remove removed request requested required requires restangular s3 s3_url sampling scoreset scoring_dataset separator service set single size source source_ids split string subset subsets tabulation test tested tested_learning_dataset testing train true type update updated updated_at upload url user_id view"
+      "keywords": "$classifier_id $dataset_id $header $main_modality $modalities_set_id $name $q $separator api async awesome badge build changes children_dataset_ids class classifier_id colspan create created_at creation csv data_file datafile dataset dataset_id dataset_name datasethelper datasets delete description destroy dictionary dictionary_ids differents distinction documentation escape examples existing fetch file filename filenames function generated_dictionaries_ids generation getchildren going header helpers https identifier isscore istestpart istrainpart job_ids jobshelper jssdk learned learned_learning_dataset learning learning-dataset learning_dataset learning_dataset_with_model list main_modality method methods_all methods_create methods_delete methods_get methods_getchildren methods_isscore methods_istestpart methods_istrainpart methods_split methods_update modalities_set_id model models named nb_of_lines note null original original_source_id paradox parameters params parent_dataset_id parent_dictionary patch permanently post predicsis preview ratio remove removed request requested required requires restangular s3 s3_url sampling scoreset scoring scoring_dataset separator service set single size source source_ids split string subset subsets tabulation test tested tested_learning_dataset testing train true type update updated updated_at upload url user_id view"
     },
     {
       "section": "api",

dist/predicsis-jsSDK.min.js.map

@@ -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/84e8fff/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/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>
 <div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
@@ -7,40 +7,52 @@
 <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/84e8fff/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/d47b9e6/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/84e8fff/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/d47b9e6/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/84e8fff/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/d47b9e6/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/84e8fff/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/d47b9e6/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/84e8fff/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/d47b9e6/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>
+  <li><code>dataset.source_ids.length === 0</code></li>
+  <li><code>dataset.main_modality !== null</code></li>
+  <li><code>dataset.classifier !== null</code></li>
+  <li><code>dataset.dataset_id !== null</code></li>
+</ul></div><h5 id="methods_isscore_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="isscore-page"><p>Instance of <a href="#/api/predicsis.jsSDK.models.Datasets">dataset</a></p>
+</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>
 <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/84e8fff/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/d47b9e6/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/js/docs-setup.js

@@ -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/84e8fff/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/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>
 <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/84e8fff/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/d47b9e6/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,7 @@
 </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/84e8fff/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/d47b9e6/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.datasetHelper.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/84e8fff/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/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>
 <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/84e8fff/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/d47b9e6/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>