algomaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9bc8e156c569c0ead06b621c468e38a40b334c1625dbd31d3617810baa80486
+  data.tar.gz: d016cde0d75d29db2e748308cb87afcc0e1b545ffd4e59a29b49da1868d26fdf
+SHA512:
+  metadata.gz: 4d53fe52cf931f111e964df936036b9b363162172072b0159b544f154cc22bd90414cb8cb8e52dda940ce432128a56528089ef7d0abd50c88b13cf7f78c28a21
+  data.tar.gz: 04e31b4e385cccca52ea5c523abb31d0ed3550f7c631dfb04d4fee284ddeb9ec7a38e2ae3863326294402d877cd696aba9bed7e801dbe4ce10d24548fc2ceff0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Algomaker
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "algomaker"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install algomaker
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/app/assets/stylesheets/algomaker/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/algomaker/application_controller.rb

@@ -0,0 +1,5 @@
+module Algomaker
+  class ApplicationController < ActionController::Base
+    helper KeystoneUi::Engine.helpers
+  end
+end

data/app/controllers/algomaker/datasets_controller.rb

@@ -0,0 +1,18 @@
+module Algomaker
+  class DatasetsController < Algomaker.parent_controller.constantize
+    def index
+      @sources = Algomaker.sources.all
+    end
+
+    def show
+      @source = Algomaker.source(params[:source_key])
+      @dataset = @source.dataset(params[:key])
+    end
+
+    def report
+      show
+      goal = params[:goal] == "optimize" ? :optimize : :predict
+      @report = Report.new(dataset: @dataset, outcome: params[:outcome], goal: goal)
+    end
+  end
+end

data/app/helpers/algomaker/application_helper.rb

@@ -0,0 +1,4 @@
+module Algomaker
+  module ApplicationHelper
+  end
+end

data/app/jobs/algomaker/application_job.rb

@@ -0,0 +1,4 @@
+module Algomaker
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/algomaker/application_mailer.rb

@@ -0,0 +1,6 @@
+module Algomaker
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/algomaker/application_record.rb

@@ -0,0 +1,5 @@
+module Algomaker
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/algomaker/datasets/index.html.erb

@@ -0,0 +1,15 @@
+<%= ui_show_page(title: "Datasets") %>
+<%= ui_page(max_width: :xl) do %>
+  <%= ui_page_header(title: "Datasets") %>
+  <% if @sources.empty? %>
+    <%= ui_paragraph(text: "No dataset sources are registered.") %>
+  <% end %>
+  <% @sources.each do |source| %>
+    <%= ui_section do %>
+      <%= ui_heading(text: source.title) %>
+      <% source.datasets.call.each do |dataset| %>
+        <%= ui_button(label: dataset.title, href: algomaker.dataset_path(source_key: source.key, key: dataset.key), variant: :secondary) %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/algomaker/datasets/report.html.erb

@@ -0,0 +1,41 @@
+<%= ui_show_page(title: @dataset.title) %>
+<%= ui_page(max_width: :md) do %>
+  <%= ui_page_header(title: @dataset.title) %>
+  <% if @report.row_count.zero? %>
+    <%= ui_paragraph(text: "This dataset has no rows yet.") %>
+  <% else %>
+    <%= ui_section(title: "Outcome") do %>
+      <%= ui_value_list(rows: [
+        { label: "Type", value: { yes_no: "Yes or no", one_of: "One of several", number: "Number", date: "Date", text: "Text" }.fetch(@report.outcome_type, @report.outcome_type.to_s) },
+        { label: "Rows counted", value: @report.row_count.to_s }
+      ]) %>
+    <% end %>
+    <% if @report.outcome_counts %>
+      <%= ui_section(title: "Rows for each outcome") do %>
+        <%= ui_value_list(rows: @report.outcome_counts.map { |value, count| { label: (value == true ? "Yes" : value == false ? "No" : value.to_s), value: count.to_s } }) %>
+      <% end %>
+    <% end %>
+    <%= ui_section(title: "Inputs") do %>
+      <%= ui_paragraph(text: @report.inputs.empty? ? "No inputs." : @report.inputs.map(&:label).join(", ")) %>
+    <% end %>
+    <%= ui_section(title: "Left out") do %>
+      <%= ui_paragraph(text: @report.left_out.empty? ? "No fields are left out." : @report.left_out.map(&:label).join(", ")) %>
+    <% end %>
+    <% if @report.no_model_reason.present? %>
+      <%= ui_paragraph(text: @report.no_model_reason) %>
+    <% else %>
+      <% @report.models.each do |model| %>
+        <%= ui_section do %>
+          <%= ui_heading(text: model.name) %>
+          <%= ui_paragraph(text: model.reason) %>
+          <%= ui_paragraph(text: @report.enough_rows?(model) ? "Enough rows to try training it." : "Needs #{@report.rows_still_needed(model)} more rows.") %>
+        <% end %>
+      <% end %>
+    <% end %>
+    <% if @report.distinct_values %>
+      <%= ui_section(title: "Distinct values for each input") do %>
+        <%= ui_value_list(rows: @report.inputs.map { |input| { label: input.label, value: @report.distinct_values[input.name].to_s } }) %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/algomaker/datasets/show.html.erb

@@ -0,0 +1,8 @@
+<%= ui_form_page(title: @dataset.title) %>
+<%= ui_page(max_width: :md) do %>
+  <%= ui_form(action: algomaker.dataset_report_path(source_key: @source.key, key: @dataset.key), method: :get) do %>
+    <%= ui_form_field(attribute: "outcome", label: "Outcome", type: :select, required: true, options: @dataset.fields.map { |field| [field.label, field.name] }) %>
+    <%= ui_form_field(attribute: "goal", label: "Goal", type: :select, required: true, options: [["Predict", "predict"], ["Optimize", "optimize"]]) %>
+    <%= ui_button(label: "Show") %>
+  <% end %>
+<% end %>

data/app/views/layouts/algomaker/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Algomaker</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "algomaker/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Algomaker::Engine.routes.draw do
+  resources :datasets, only: [ :index ]
+  get "sources/:source_key/datasets/:key", to: "datasets#show", as: :dataset
+  get "sources/:source_key/datasets/:key/report", to: "datasets#report", as: :dataset_report
+end

data/lib/algomaker/dataset.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Algomaker
+  class Dataset < Data.define(:key, :title, :fields, :rows)
+    def field(name)
+      fields.find { |field| field.name == name.to_sym }
+    end
+  end
+end

data/lib/algomaker/engine.rb

@@ -0,0 +1,5 @@
+module Algomaker
+  class Engine < ::Rails::Engine
+    isolate_namespace Algomaker
+  end
+end

data/lib/algomaker/field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Algomaker
+  class Field < Data.define(:name, :label, :type, :position)
+    TYPES = %i[yes_no one_of number date text].freeze
+
+    def initialize(name:, label:, type:, position:)
+      raise ArgumentError, "#{name} has a type algomaker does not know: #{type}" unless TYPES.include?(type)
+
+      super
+    end
+  end
+end

data/lib/algomaker/model_guide.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Algomaker
+  module ModelGuide
+    Model = Data.define(:name, :outcome_types, :reason, :rows_per_input)
+
+    MODELS = [
+      Model.new(
+        name: "Logistic regression",
+        outcome_types: %i[yes_no],
+        reason: "It gives the chance of a yes from inputs that each raise or lower it, and shows how much each input counts.",
+        rows_per_input: 10
+      ),
+      Model.new(
+        name: "Multinomial logistic regression",
+        outcome_types: %i[one_of],
+        reason: "It gives the chance of each of several outcomes from inputs that each raise or lower them.",
+        rows_per_input: 10
+      ),
+      Model.new(
+        name: "Linear regression",
+        outcome_types: %i[number],
+        reason: "It predicts an amount as a sum of what each input adds or takes away.",
+        rows_per_input: 10
+      ),
+      Model.new(
+        name: "Time-to-event model",
+        outcome_types: %i[date],
+        reason: "It predicts how long until the outcome's date from the inputs known before it.",
+        rows_per_input: 10
+      ),
+      Model.new(
+        name: "Gradient-boosted trees",
+        outcome_types: %i[yes_no one_of number],
+        reason: "It finds outcomes that depend on several inputs together, at the cost of needing more rows.",
+        rows_per_input: 50
+      )
+    ].freeze
+
+    def self.for(outcome_type)
+      MODELS.select { |model| model.outcome_types.include?(outcome_type) }
+    end
+  end
+end

data/lib/algomaker/report.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Algomaker
+  class Report
+    def initialize(dataset:, outcome:, goal:)
+      @dataset = dataset
+      @outcome = dataset.field(outcome)
+      @goal = goal
+    end
+
+    def outcome_type
+      @outcome.type
+    end
+
+    def inputs
+      others.select { |field| field.position < @outcome.position }
+    end
+
+    def left_out
+      others - inputs
+    end
+
+    def models
+      ModelGuide.for(outcome_type)
+    end
+
+    def rows_still_needed(model)
+      [ model.rows_per_input * inputs.size - rows_that_limit, 0 ].max
+    end
+
+    def enough_rows?(model)
+      rows_still_needed(model).zero?
+    end
+
+    def distinct_values
+      return unless @goal == :optimize
+
+      inputs.to_h { |input| [ input.name, rows.map { |row| row[input.name] }.uniq.size ] }
+    end
+
+    def no_model_reason
+      "No type of model is named for a text outcome." if outcome_type == :text
+    end
+
+    def row_count
+      rows.size
+    end
+
+    COUNTED_TYPES = %i[yes_no one_of].freeze
+
+    def outcome_counts
+      return unless COUNTED_TYPES.include?(@outcome.type)
+
+      unseen_answers.merge(rows.map { |row| row[@outcome.name] }.tally)
+    end
+
+    private
+
+    def unseen_answers
+      @outcome.type == :yes_no ? { true => 0, false => 0 } : {}
+    end
+
+    def rows_that_limit
+      outcome_counts ? outcome_counts.values.min.to_i : row_count
+    end
+
+    def others
+      @dataset.fields - [ @outcome ]
+    end
+
+    def rows
+      @rows ||= @dataset.rows.call.reject { |row| row[@outcome.name].nil? }
+    end
+  end
+end

data/lib/algomaker/source_registry.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Algomaker
+  class Source < Data.define(:key, :title, :datasets)
+    def dataset(key)
+      datasets.call.find { |dataset| dataset.key == key.to_sym }
+    end
+  end
+
+  class SourceRegistry
+    def initialize
+      @sources = {}
+    end
+
+    def register(key:, title:, datasets:)
+      @sources[key.to_sym] = Source.new(key: key.to_sym, title: title, datasets: datasets)
+    end
+
+    def all
+      @sources.values
+    end
+
+    def fetch(key)
+      @sources.fetch(key.to_sym)
+    end
+  end
+end

data/lib/algomaker/version.rb

@@ -0,0 +1,3 @@
+module Algomaker
+  VERSION = "0.1.0"
+end

data/lib/algomaker.rb

@@ -0,0 +1,28 @@
+require "keystone_ui"
+require "algomaker/version"
+require "algomaker/engine"
+require "algomaker/field"
+require "algomaker/dataset"
+require "algomaker/model_guide"
+require "algomaker/report"
+require "algomaker/source_registry"
+
+module Algomaker
+  mattr_accessor :parent_controller, default: "Algomaker::ApplicationController"
+
+  def self.sources
+    @sources ||= SourceRegistry.new
+  end
+
+  def self.register_source(key:, title:, datasets:)
+    sources.register(key: key, title: title, datasets: datasets)
+  end
+
+  def self.source(key)
+    sources.fetch(key)
+  end
+
+  def self.reset_sources!
+    @sources = SourceRegistry.new
+  end
+end

data/lib/tasks/algomaker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :algomaker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: algomaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Schneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: keystone_ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+description: Algomaker takes datasets a host app registers, and for an outcome the
+  owner picks reports whether there are enough rows to train a model and which types
+  of model suit it.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/algomaker/application.css
+- app/controllers/algomaker/application_controller.rb
+- app/controllers/algomaker/datasets_controller.rb
+- app/helpers/algomaker/application_helper.rb
+- app/jobs/algomaker/application_job.rb
+- app/mailers/algomaker/application_mailer.rb
+- app/models/algomaker/application_record.rb
+- app/views/algomaker/datasets/index.html.erb
+- app/views/algomaker/datasets/report.html.erb
+- app/views/algomaker/datasets/show.html.erb
+- app/views/layouts/algomaker/application.html.erb
+- config/routes.rb
+- lib/algomaker.rb
+- lib/algomaker/dataset.rb
+- lib/algomaker/engine.rb
+- lib/algomaker/field.rb
+- lib/algomaker/model_guide.rb
+- lib/algomaker/report.rb
+- lib/algomaker/source_registry.rb
+- lib/algomaker/version.rb
+- lib/tasks/algomaker_tasks.rake
+homepage: https://github.com/DYB-Development/algomaker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/algomaker
+  source_code_uri: https://github.com/DYB-Development/algomaker
+  changelog_uri: https://github.com/DYB-Development/algomaker/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A Rails engine that judges whether a dataset can train a model.
+test_files: []