clarification 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14dba1413119dc7a3ad0e944dfcbd825b40eb326
-  data.tar.gz: 205ad9143ccb00f1b5f9777383358a2b9abd0870
+  metadata.gz: 196adfa8582e30a4ec2e5ac0ef5afeceb7a0c5ce
+  data.tar.gz: 7b2d38f850dc20a8694bf03af3888b110fa5a82c
 SHA512:
-  metadata.gz: 31c796e17b2e9942b4f85340f979a7c08d268b6615b74ea234aca305cefc71e09810790f9d138f30ef72ba9d7e4742d3400049fb27e0cb83dbdbba8b5c047b0a
-  data.tar.gz: a93bab9d28a78f65105dd7efe3286b8db22843c16781d0db017a6932fe8dca53a0f609949761cc08a6e107ed00f455c7a96a7079663dc366cce4d12d94f3f3df
+  metadata.gz: 35a9592a72c30a67ccf53e68903ce8c58aab6eaf2a634d3517baac2d105a6636fb19a7e887e5515b522137cfbe693e9d2350c906e06c87b637f477cff4a1e0b4
+  data.tar.gz: '073775787600d87b2864b0c70a1a5cc7ce4b729aa39984faf453eb5a79f45f02ac12987aa187e1f308f646d1072bb1727b3251d7d19a810d512d493bea24a15c'

data/.travis.yml

@@ -5,3 +5,14 @@ rvm:
   - 2.3
   - 2.2
 before_install: gem install bundler -v 1.15.4
+env:
+  global:
+    - CC_TEST_REPORTER_ID=4baf3d26837a411d55ee4f861c8d49265755a03f4a0bb35fba9290cedae3f233
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at TODO: Write your email address. All
+reported by contacting the project team at nichol.alexander@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 TODO: Write your name
+Copyright (c) 2017 Nichol Alexander
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/clarification.svg)](https://badge.fury.io/rb/clarification)
 [![Build Status](https://travis-ci.org/nicholalexander/clarification.svg?branch=master)](https://travis-ci.org/nicholalexander/clarification)
+[![Test Coverage](https://codeclimate.com/github/nicholalexander/clarification/badges/coverage.svg)](https://codeclimate.com/github/nicholalexander/clarification/coverage)
+[![Code Climate](https://codeclimate.com/github/nicholalexander/clarification/badges/gpa.svg)](https://codeclimate.com/github/nicholalexander/clarification)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb0dd6cce7ec48a191696780951c5efe)](https://www.codacy.com/app/nicholalexander/clarification?utm_source=github.com&utm_medium=referral&utm_content=nicholalexander/clarification&utm_campaign=Badge_Grade)
 
 # Clarification
@@ -96,7 +98,7 @@ image_array = [ url_to_picture_of_kitten, url_to_picture_of_pizza, url_to_pictur
 client.search.index_images(image_array)
 ```
 
-Once you have your images indexed, you can go and search them by concepts that might be in your picture as identified by Clarifai's general prediction model.
+Once you have your images indexed, you can go and search them by concepts that might be in your pictures as identified by Clarifai's general prediction model.
 
 ```ruby
 results = client.search.by_concept('cat')
@@ -116,6 +118,23 @@ Go and do likewise.
 
 ### Train
 
+There are three steps to setting up a custom model:
+
+* Add images with concepts.  
+* Create a model with the same concepts that you've associated with images.
+* Train said model.
+
+These three steps can be accomplished thusly:
+
+```ruby
+cat_related_concepts = ["cat", "feline", "superior"]
+client.train.add_image(some_url_of_a_cat, cat_related_concepts)
+client.train.create_model('cat', cat_related_concepts)
+client.train.train_model('cat')
+```
+
+Now that you have the model created and trained, you should be able to predict against it.  Except right now, that's not implemented in the Gem... womp womp.
+
 ## TODO's
 
 Lots and lots of things.  Amongst them:
@@ -124,11 +143,10 @@ Lots and lots of things.  Amongst them:
 * error handling
 * predict multiple images per call
 * predict video
-* better testing.
+* better testing
 * documentation
 * use workflows
-* searching
-* training custom models
+* predict against 
 
 ## Development
 
@@ -140,7 +158,7 @@ The repo intentionally includes an api key in bin/console to make experimenting
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nicholalexander/clarification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-You can also see various code reporting / CI info here:
+You can also see various code reporting / CI info here:  
 [travis ci](https://travis-ci.org/nicholalexander/clarification)  
 [codacy](https://www.codacy.com/app/nicholalexander/clarification)  
 [code climate](https://codeclimate.com/github/nicholalexander/clarification)   

data/bin/console

@@ -12,7 +12,7 @@ Clarification.configure do |config|
   config.default_public_models = [:food, :general]
 end
 
-@images = YAML.load_file("spec/support/images.yml")
+@images = YAML.load_file("spec/fixtures/images.yml")
         
 @urls = [ @images[:mountains], @images[:kitten], @images[:drake] ]
 
@@ -40,6 +40,11 @@ end
 # @client.search.by_concepts
 # @client.search.by_images
 
+@url = @images[:faces]
+@concepts = ["faces", "people", "humans"]
+@client.train.add_image(@url, @concepts)
+@client.train.create_model('faces', @concepts)
+@client.train.train_model('faces')
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"

data/clarification.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "codacy-coverage"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
   
 end

data/lib/clarification.rb

@@ -9,7 +9,9 @@ require "clarification/response"
 require "clarification/response/search_response"
 require "clarification/requester"
 require "clarification/requester/search_requester"
+require "clarification/requester/train_requester"
 require "clarification/search"
+require "clarification/train"
 require "clarification/version"
 
 require 'net/http'

data/lib/clarification/client.rb

@@ -1,13 +1,14 @@
 module Clarification
   class Client
 
-    attr_reader :active_public_models, :last_response, :search
+    attr_reader :active_public_models, :last_response, :search, :train
 
     def initialize
       raise "No Configuration Found." if Clarification.configuration.nil?
       @active_public_models = Clarification.configuration.default_public_models
       @last_response = nil
       @search = Search.new
+      @train = Train.new
     end
     
     def predict(url)

data/lib/clarification/requester.rb

@@ -1,7 +1,7 @@
 module Clarification
   class Requester
 
-    def initialize(model_array)
+    def initialize(model_array=[])
       @model_array = model_array
     end
 
@@ -28,8 +28,6 @@ module Clarification
       return response
     end
 
-    private
-
     def body_builder(url)
       {
         "inputs": [

data/lib/clarification/requester/train_requester.rb

@@ -0,0 +1,82 @@
+module Clarification
+  class TrainRequester < Clarification::Requester
+
+    def add_image_with_concepts(target_url, concept_array)
+      uri = uri_builder("inputs")
+      body = image_with_concepts_body_builder(target_url, concept_array)
+      response = get_response(uri, body)
+      return response
+    end
+
+    def create_model(name, concept_array)
+      uri = uri_builder("models")
+      body = create_model_body_builder(name, concept_array)
+      response = get_response(uri, body)
+      return response
+    end
+
+    def train_model(id)
+      uri = uri_builder("models/#{id}/versions")
+      body = {}
+      response = get_response(uri, body)
+      return response
+    end
+
+    private
+
+    def uri_builder(path)
+      url = "#{Clarification::BASE_URL}#{path}"
+      URI.parse(url)
+    end
+
+    def image_with_concepts_body_builder(target_url, concept_array)
+      body_concepts = []
+
+      concept_array.each do |concept|
+        body_concepts << {
+          id: concept,
+          value: true
+        }  
+      end
+
+      {
+        inputs: [
+          {
+            data: {
+              image: {
+                url: target_url
+              },
+              concepts: body_concepts
+            }
+          }
+        ]
+      }
+    end
+
+    def create_model_body_builder(name, concept_array)
+      body_concepts = []
+
+      concept_array.each do |concept|
+        body_concepts << {
+          id: concept,
+        }  
+      end
+
+      {
+        model: {
+          id: name,
+          output_info: {
+            data: {
+              concepts: body_concepts
+            },
+            output_config: {
+              concepts_mutually_exclusive: false,
+              closed_environment:false
+            }
+          }
+        }
+      }
+    end
+
+  end
+end

data/lib/clarification/train.rb

@@ -0,0 +1,27 @@
+module Clarification
+  class Train
+
+    def initialize
+      @model_id = nil
+    end
+
+    def add_image(image, concept_array)
+      training_requester = TrainRequester.new
+      response = training_requester.add_image_with_concepts(image, concept_array)
+      return response # will be mostly status
+    end
+    
+    def create_model(name, concept_array)
+      training_requester = TrainRequester.new
+      response = training_requester.create_model(name, concept_array)
+      return response # should contain id and set model id?
+    end
+    
+    def train_model(id)
+      training_requester = TrainRequester.new
+      response = training_requester.train_model(id)
+      return response # should be status.
+    end
+
+  end
+end

data/lib/clarification/version.rb

@@ -1,3 +1,3 @@
 module Clarification
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clarification
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nichol Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -123,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codacy-coverage
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,9 +179,11 @@ files:
 - lib/clarification/objectifier.rb
 - lib/clarification/requester.rb
 - lib/clarification/requester/search_requester.rb
+- lib/clarification/requester/train_requester.rb
 - lib/clarification/response.rb
 - lib/clarification/response/search_response.rb
 - lib/clarification/search.rb
+- lib/clarification/train.rb
 - lib/clarification/version.rb
 homepage: https://github.com/nicholalexander/clarification
 licenses: