tangram 0.6.1 → 0.7.0

data/docs/Tangram/FeatureContributions.html

@@ -101,7 +101,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>This is a description of the feature contributions for the prediction if the task is regression or binary classification, or for a single class if the task is multiclass classification.</p>
+    
+<p>This is a description of the feature contributions for the prediction if the task is regression or binary classification, or for a single class if the task is multiclass classification.</p>
 
 
   </div>
@@ -138,7 +139,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This is the value the model would output if all features had baseline values.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This is the value the model would output if all features had baseline values.</p>
 </div></span>
   
 </li>
@@ -166,7 +168,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This list will contain one entry for each of the model&#39;s features.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This list will contain one entry for each of the model&#39;s features.</p>
 </div></span>
   
 </li>
@@ -194,7 +197,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This is the value the model output.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This is the value the model output.</p>
 </div></span>
   
 </li>
@@ -232,7 +236,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of FeatureContributions.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of FeatureContributions.</p>
 </div></span>
   
 </li>
@@ -255,7 +260,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of FeatureContributions.</p>
+    
+<p>Returns a new instance of FeatureContributions.</p>
 
 
   </div>
@@ -306,7 +312,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This is the value the model would output if all features had baseline values.</p>
+    
+<p>This is the value the model would output if all features had baseline values.</p>
 
 
   </div>
@@ -348,7 +355,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This list will contain one entry for each of the model&#39;s features. Note that features are computed from columns, so there will likely be more features than columns.</p>
+    
+<p>This list will contain one entry for each of the model&#39;s features. Note that features are computed from columns, so there will likely be more features than columns.</p>
 
 
   </div>
@@ -390,7 +398,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This is the value the model output. Any difference from the <code>baseline_value</code> is because of the deviation of the features from their baseline values.</p>
+    
+<p>This is the value the model output. Any difference from the <code>baseline_value</code> is because of the deviation of the features from their baseline values.</p>
 
 
   </div>
@@ -425,9 +434,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:34 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>

data/docs/Tangram/IdentityFeatureContribution.html

@@ -101,7 +101,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>This describes the contribution of a feature from an identity feature group.</p>
+    
+<p>This describes the contribution of a feature from an identity feature group.</p>
 
 
   </div>
@@ -138,7 +139,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This is the name of the source column for the feature group.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This is the name of the source column for the feature group.</p>
 </div></span>
   
 </li>
@@ -166,7 +168,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This is the amount that the feature contributed to the output.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This is the amount that the feature contributed to the output.</p>
 </div></span>
   
 </li>
@@ -194,7 +197,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>This is the value of the feature.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>This is the value of the feature.</p>
 </div></span>
   
 </li>
@@ -232,7 +236,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of IdentityFeatureContribution.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of IdentityFeatureContribution.</p>
 </div></span>
   
 </li>
@@ -255,7 +260,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of IdentityFeatureContribution.</p>
+    
+<p>Returns a new instance of IdentityFeatureContribution.</p>
 
 
   </div>
@@ -306,7 +312,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This is the name of the source column for the feature group.</p>
+    
+<p>This is the name of the source column for the feature group.</p>
 
 
   </div>
@@ -348,7 +355,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This is the amount that the feature contributed to the output.</p>
+    
+<p>This is the amount that the feature contributed to the output.</p>
 
 
   </div>
@@ -390,7 +398,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>This is the value of the feature.</p>
+    
+<p>This is the value of the feature.</p>
 
 
   </div>
@@ -425,9 +434,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:34 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>

data/docs/Tangram/LibTangram.html

@@ -151,9 +151,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:33 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>

data/docs/Tangram/LibTangram/TangramStringView.html

@@ -183,9 +183,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:34 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>

data/docs/Tangram/LoadModelOptions.html

@@ -101,7 +101,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>These are the options passed when loading a model.</p>
+    
+<p>These are the options passed when loading a model.</p>
 
 
   </div>
@@ -138,7 +139,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>If you are running the app locally or on your own server, use this field to provide the url to it.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>If you are running the app locally or on your own server, use this field to provide the url to it.</p>
 </div></span>
   
 </li>
@@ -176,7 +178,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of LoadModelOptions.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of LoadModelOptions.</p>
 </div></span>
   
 </li>
@@ -199,7 +202,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of LoadModelOptions.</p>
+    
+<p>Returns a new instance of LoadModelOptions.</p>
 
 
   </div>
@@ -246,7 +250,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>If you are running the app locally or on your own server, use this field to provide the url to it. If not specified, the default value is <a href="https://app.tangram.xyz">https://app.tangram.xyz</a>.</p>
+    
+<p>If you are running the app locally or on your own server, use this field to provide the url to it. If not specified, the default value is <a href="https://app.tangram.dev">app.tangram.dev</a>.</p>
 
 
   </div>
@@ -281,9 +286,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:33 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>

data/docs/Tangram/Model.html

@@ -101,7 +101,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>Use this class to load a model, make predictions, and log events to the app.</p>
+    
+<p>Use this class to load a model, make predictions, and log events to the app.</p>
 
 
   </div>
@@ -141,7 +142,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Load a model from bytes instead of a file.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Load a model from bytes instead of a file.</p>
 </div></span>
   
 </li>
@@ -164,7 +166,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Load a model from the <code>.tangram</code> file at <code>path</code>.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Load a model from the <code>.tangram</code> file at <code>path</code>.</p>
 </div></span>
   
 </li>
@@ -196,7 +199,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Add a prediction event to the queue.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Add a prediction event to the queue.</p>
 </div></span>
   
 </li>
@@ -219,7 +223,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Add a true value event to the queue.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Add a true value event to the queue.</p>
 </div></span>
   
 </li>
@@ -242,7 +247,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Send all events in the queue to the app.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Send all events in the queue to the app.</p>
 </div></span>
   
 </li>
@@ -265,7 +271,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Retrieve the model&#39;s id.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Retrieve the model&#39;s id.</p>
 </div></span>
   
 </li>
@@ -290,7 +297,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of Model.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Model.</p>
 </div></span>
   
 </li>
@@ -313,7 +321,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Send a prediction event to the app.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Send a prediction event to the app.</p>
 </div></span>
   
 </li>
@@ -336,7 +345,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Send a true value event to the app.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Send a true value event to the app.</p>
 </div></span>
   
 </li>
@@ -359,7 +369,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Make a prediction!.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Make a prediction!.</p>
 </div></span>
   
 </li>
@@ -382,7 +393,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of Model.</p>
+    
+<p>Returns a new instance of Model.</p>
 
 
   </div>
@@ -406,7 +418,7 @@
       <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 257</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_c_model'>c_model</span><span class='comma'>,</span> <span class='label'>options:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='ivar'>@tangram_url</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='op'>&amp;.</span><span class='id identifier rubyid_tangram_url'>tangram_url</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://app.tangram.xyz</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_options'>options</span><span class='op'>&amp;.</span><span class='id identifier rubyid_tangram_url'>tangram_url</span>
+  <span class='ivar'>@tangram_url</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='op'>&amp;.</span><span class='id identifier rubyid_tangram_url'>tangram_url</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://app.tangram.dev</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_options'>options</span><span class='op'>&amp;.</span><span class='id identifier rubyid_tangram_url'>tangram_url</span>
   <span class='ivar'>@log_queue</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
   <span class='ivar'>@model</span> <span class='op'>=</span> <span class='const'>FFI</span><span class='op'>::</span><span class='const'>AutoPointer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_c_model'>c_model</span><span class='period'>.</span><span class='id identifier rubyid_read_pointer'>read_pointer</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="LibTangram.html" title="Tangram::LibTangram (module)">LibTangram</a></span></span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:tangram_model_delete</span><span class='rparen'>)</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
@@ -433,7 +445,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Load a model from bytes instead of a file. You should use this only if you already have a <code>.tangram</code> loaded into memory. Otherwise, use <code>Model.from_path</code>, which is faster because it memory maps the file.</p>
+    
+<p>Load a model from bytes instead of a file. You should use this only if you already have a <code>.tangram</code> loaded into memory. Otherwise, use <code>Model.from_path</code>, which is faster because it memory maps the file.</p>
 
 
   </div>
@@ -452,7 +465,8 @@
       
       
         &mdash;
-        <div class='inline'><p>The bytes for the .tangram model.</p>
+        <div class='inline'>
+<p>The bytes for the .tangram model.</p>
 </div>
       
     </li>
@@ -469,7 +483,8 @@
       
       
         &mdash;
-        <div class='inline'><p>The options to use when loading the model.</p>
+        <div class='inline'>
+<p>The options to use when loading the model.</p>
 </div>
       
     </li>
@@ -538,7 +553,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Load a model from the <code>.tangram</code> file at <code>path</code>.</p>
+    
+<p>Load a model from the <code>.tangram</code> file at <code>path</code>.</p>
 
 
   </div>
@@ -557,7 +573,8 @@
       
       
         &mdash;
-        <div class='inline'><p>The path to the <code>.tangram</code> file.</p>
+        <div class='inline'>
+<p>The path to the <code>.tangram</code> file.</p>
 </div>
       
     </li>
@@ -574,7 +591,8 @@
       
       
         &mdash;
-        <div class='inline'><p>The options to use when loading the model.</p>
+        <div class='inline'>
+<p>The options to use when loading the model.</p>
 </div>
       
     </li>
@@ -649,7 +667,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Add a prediction event to the queue. Remember to call <code>flush_log_queue</code> at a later point to send the event to the app.</p>
+    
+<p>Add a prediction event to the queue. Remember to call <code>flush_log_queue</code> at a later point to send the event to the app.</p>
 
 
   </div>
@@ -668,7 +687,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
+        <div class='inline'>
+<p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
 </div>
       
     </li>
@@ -683,7 +703,8 @@
       
       
         &mdash;
-        <div class='inline'><p>A single <code>PredictInput</code>.</p>
+        <div class='inline'>
+<p>A single <code>PredictInput</code>.</p>
 </div>
       
     </li>
@@ -698,7 +719,8 @@
       
       
         &mdash;
-        <div class='inline'><p>A single <code>PredictOutput</code>.</p>
+        <div class='inline'>
+<p>A single <code>PredictOutput</code>.</p>
 </div>
       
     </li>
@@ -715,7 +737,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is the same <code>predictOptions</code> value that you passed to <code>predict</code>.</p>
+        <div class='inline'>
+<p>This is the same <code>predictOptions</code> value that you passed to <code>predict</code>.</p>
 </div>
       
     </li>
@@ -767,7 +790,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Add a true value event to the queue. Remember to call <code>flush_log_queue</code> at a later point to send the event to the app.</p>
+    
+<p>Add a true value event to the queue. Remember to call <code>flush_log_queue</code> at a later point to send the event to the app.</p>
 
 
   </div>
@@ -786,7 +810,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
+        <div class='inline'>
+<p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
 </div>
       
     </li>
@@ -801,7 +826,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is the true value for the prediction.</p>
+        <div class='inline'>
+<p>This is the true value for the prediction.</p>
 </div>
       
     </li>
@@ -849,7 +875,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Send all events in the queue to the app.</p>
+    
+<p>Send all events in the queue to the app.</p>
 
 
   </div>
@@ -891,7 +918,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Retrieve the model&#39;s id.</p>
+    
+<p>Retrieve the model&#39;s id.</p>
 
 
   </div>
@@ -935,7 +963,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Send a prediction event to the app. If you want to batch events, you can use <code>enqueue_log_prediction</code> instead.</p>
+    
+<p>Send a prediction event to the app. If you want to batch events, you can use <code>enqueue_log_prediction</code> instead.</p>
 
 
   </div>
@@ -954,7 +983,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
+        <div class='inline'>
+<p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
 </div>
       
     </li>
@@ -969,7 +999,8 @@
       
       
         &mdash;
-        <div class='inline'><p>A single <code>PredictInput</code>.</p>
+        <div class='inline'>
+<p>A single <code>PredictInput</code>.</p>
 </div>
       
     </li>
@@ -984,7 +1015,8 @@
       
       
         &mdash;
-        <div class='inline'><p>A single <code>PredictOutput</code>.</p>
+        <div class='inline'>
+<p>A single <code>PredictOutput</code>.</p>
 </div>
       
     </li>
@@ -1001,7 +1033,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is the same <code>predictOptions</code> value that you passed to <code>predict</code>.</p>
+        <div class='inline'>
+<p>This is the same <code>predictOptions</code> value that you passed to <code>predict</code>.</p>
 </div>
       
     </li>
@@ -1053,7 +1086,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Send a true value event to the app. If you want to batch events, you can use <code>enqueue_log_true_value</code> instead.</p>
+    
+<p>Send a true value event to the app. If you want to batch events, you can use <code>enqueue_log_true_value</code> instead.</p>
 
 
   </div>
@@ -1072,7 +1106,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
+        <div class='inline'>
+<p>This is a unique identifier for the prediction, which will associate it with a true value event and allow you to look it up in the app.</p>
 </div>
       
     </li>
@@ -1087,7 +1122,8 @@
       
       
         &mdash;
-        <div class='inline'><p>This is the true value for the prediction.</p>
+        <div class='inline'>
+<p>This is the true value for the prediction.</p>
 </div>
       
     </li>
@@ -1135,7 +1171,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Make a prediction!</p>
+    
+<p>Make a prediction!</p>
 
 
   </div>
@@ -1154,7 +1191,8 @@
       
       
         &mdash;
-        <div class='inline'><p>A predict input is either a single predict input which is a map from symbols or strings to strings or floats or an array of such maps. The keys should match the columns in the CSV file you trained your model with.</p>
+        <div class='inline'>
+<p>A predict input is either a single predict input which is a map from symbols or strings to strings or floats or an array of such maps. The keys should match the columns in the CSV file you trained your model with.</p>
 </div>
       
     </li>
@@ -1171,7 +1209,8 @@
       
       
         &mdash;
-        <div class='inline'><p>These are the predict options.</p>
+        <div class='inline'>
+<p>These are the predict options.</p>
 </div>
       
     </li>
@@ -1189,7 +1228,8 @@
       
       
         &mdash;
-        <div class='inline'><p>. Return a single output if <code>input</code> was a single input, or an array if <code>input</code> was an array of <code>input</code>s.</p>
+        <div class='inline'>
+<p>. Return a single output if <code>input</code> was a single input, or an array if <code>input</code> was an array of <code>input</code>s.</p>
 </div>
       
     </li>
@@ -1240,9 +1280,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jul 15 14:34:34 2021 by
+  Generated on Mon Jul 26 14:54:00 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.3).
+  0.9.26 (ruby-2.7.4).
 </div>
 
     </div>