data_modeler 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aa7bca947d38ae6dbe7f68f157fde886eaecc43
-  data.tar.gz: 892e6adc2270f574124950df2ff39bc5fe5a3fa5
+  metadata.gz: ea57e751cee00062d76e425d59b9c5a6fba273d5
+  data.tar.gz: 15092c42c80bde72d6ee710d6495a9ff8dc6a28d
 SHA512:
-  metadata.gz: 6cbb4bfe5ce7ca9aafb61eb78f9d85021a36c0f43987f0c638358f67b5baed1c30ad2e15fb20ae4d1b59ca7888e15a8974418f077df3770f330ada0a92ba3738
-  data.tar.gz: 3bb014b31c5b82f01411448d2759fe10032a7031921aed0d0fb91bd6ec29ae7222f18beb761aa23cb08f77b5fa1df121d90682937c5a6ab43b325dcf6a46fc5e
+  metadata.gz: 1835c0d942162a62b8713e6e255016d9aec1a8e8ccec97d4bc9438b77b8f9e0bea20affb698bb6be10553151a82b1d87b9264438319fc405d8d4c9df8a07101c
+  data.tar.gz: 1ee72d1334169d21a25f18fada689dd4a417a2a8251e5bfb51db7b7eeb6891261c4981ff6a29a4639f75d67c95b1e8ae8f263566043d9fec09ede5fe1fcb4194

data/README.md

@@ -7,8 +7,7 @@
 [![Code Climate](https://codeclimate.com/github/giuse/data_modeler/badges/gpa.svg)](https://codeclimate.com/github/giuse/data_modeler)
 
 
-**Using machine learning, create generative models based on your data alone.  
-Applications span from prediction to imputation and compression.**
+**Using machine learning, create generative models based on your data.**
 
 
 ## Installation
@@ -68,7 +67,9 @@ This means that to know all available options you should rely on a previous conf
 
 There are three settings under `:tset` in the config which may be cryptic: `ninput_points`, `tspread` and `look_ahead`. Names can change in the future as I found it hard to name these three, please open an issue if I forget to modify this (or if you have suggestions).
 
-If you don't work with time series, just set them to [1,0,0], use a line counter for `time`, and ignore the following. These three only make sense if the data is composed of aligned time series, with a numeric column `time` -- its unit will also be the unit for `tspread` and `look_ahead`. 
+If you don't work with time series, just set them to `[1,0,0]`, use a line counter for `time`, and ignore the following. These three only make sense if the data is composed of aligned time series, with a numeric column `time` -- its unit will also be the unit for `tspread` and `look_ahead`.
+
+The data needs to be indexed (i.e. no repetitions) and sorted by `time`. This implies that different data "lines" in the following explanation have different time values.
 
 - ninput_points: how many points in time to construct the model's input. For example, if the number is 3, then data coming from 3 data lines is considered.
 - tspread: time spread between the data lines considered in the point above. For example, if the number is 2, then the data lines considered will have (at least) 2 time (units) between each other.
@@ -76,16 +77,16 @@ If you don't work with time series, just set them to [1,0,0], use a line counter
 
 *Example configurations:*
 
-- ninput_points = 1, tspread = 0, look_ahead = 0 -> build input from one line, no spreading, predict results in same line. This is the basic configuration allowing same-timestep prediction, e.g. for static modeling or simple data imputation.
-- ninput_points = 4, tspread = 7, look_ahead = 7 -> hypothesize the unit of the column `time` to be days: build input from 4 lines spanning 21 days at one-week intervals (+ current), then use it to learn to predict one week ahead. This allows to train a proper time-ahead predictor, which will estimate the target at a constant one-week ahead interval.
-- ninput_points = 30, tspread = 1, look_ahead = 1 -> hypothesize the unit of the column `time` to be seconds: train a real-time predictor estimating a behavior one-second ahead based on 1s-spaced data over the past 29 seconds + current.
+- ninput_points = `1`, tspread = `0`, look_ahead = `0` -> build input from one line, no spreading, predict results in same line. This is the basic configuration allowing same-timestep prediction, e.g. for static modeling or simple data imputation.
+- ninput_points = `4`, tspread = `7`, look_ahead = `7` -> hypothesize the unit of the column `time` to be days: build input from 4 lines spanning 21 days at one-week intervals (+ current), then use it to learn to predict one week ahead. This allows to train a proper time-ahead predictor, which will estimate the target at a constant one-week ahead interval.
+- ninput_points = `30`, tspread = `1`, look_ahead = `1` -> hypothesize the unit of the column `time` to be seconds: train a real-time predictor estimating a behavior one-second ahead based on 1s-spaced data over the past 29 seconds + current.
 
 Important: from each line, only the data coming from the listed input time series is considered for input, while the target time series list is used to construct the output.
 
 *Example inputs and targets*, considering `t0` the "current" time for a given iteration:
 
-- ninput_points = 1, tspread = 0, look_ahead = 0, input_series = [s1, s4], targets = [s3]: inputs -> [s1t0, s2t0], targets = [s3t0]
-- ninput_points = 4, tspread = 7, look_ahead = 7, input_series = [s1, s4], targets = [s3, s5]: inputs -> [s1t-21, s2t-21, s1t-14, s2t-14, s1t-7, s2t-7, s1t0, s2t0], targets = [s3t7, s5t7]
+- ninput_points = `1`, tspread = `0`, look_ahead = `0`, input_series = `[s1, s4]`, targets = `[s3]`: inputs -> `[s1t0, s4t0]`, targets = [s3t0]
+- ninput_points = `4`, tspread = `7`, look_ahead = `7`, input_series = `[s1, s4]`, targets = `[s3, s5]`: inputs -> `[s1t-21, s4t-21, s1t-14, s4t-14, s1t-7, s4t-7, s1t0, s4t0]`, targets = `[s3t7, s5t7]`
 
 
 ## Contributing

data/lib/data_modeler/version.rb

@@ -1,5 +1,5 @@
 # Main gem module
 module DataModeler
   # Version number
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_modeler
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Giuseppe Cuccu