twentybn 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6b10369f03378969df930262655fafeff21db3
-  data.tar.gz: b43d185445fbc5c63458438c92c765230271f84e
+  metadata.gz: 15037c788b461bc1d7343c9d4fd9f519287e5273
+  data.tar.gz: 5b573ad757d66745cddabc9890666a971c29663f
 SHA512:
-  metadata.gz: 65c6e73a2d5134ea25f8b51b6d7806a3477be38da30faa4b3943848856d03211e2cfba4f8881c05a91499b9a46eb9f79ad7de1180bce61c678628e1823ba26e8
-  data.tar.gz: 396f81d7b375ea26dcd92b0acb9a07a00e36cce1e1726f2d1849847a0773ea14246d49cfc312eb25bcd09ba48c1cd38b4f3008a4bf33b42ced2e79c5836c7643
+  metadata.gz: 68eb494036f06df1f962b0b0dbb4b228ed1dd7950a4b3b95cfb4f77e31eca2c7466ba8f4bb5a7a3d103e414ced914dcc92c7a3513f34f5f65ba5c59231c712f3
+  data.tar.gz: 127bae132cd9bb6b20488383f88199009f6ce65c7d84040cd155c2fae5f341b2eb39c4c516368da0e6e07a4ba243e8340d03b69ddd424847301f24bc2d4bd6b0

data/README.md

@@ -24,14 +24,41 @@ In order to get an API key, you need to sign up for free at https://cortex.twent
 
 ## Basic usage
 
+### Image tagging
+
+Image tagging returns tags for a given image by applying a neural networks based classifier on the image. The basic usage is as follows:
+
 ```ruby
 require 'twentybn'
 TwentyBN.api_key = 'PUT_API_KEY_HERE'
 tags = TwentyBN.image("/path/to/an/image.jpg").tag
-answer = TwentyBN.image("/path/to/an/image.jpg").ask("What is the man doing?")
 ```
 
-## Configure Rails application
+The result will look like this:
+```ruby
+{
+    "result"=> {
+        "scores"=> [
+            0.6320463418960571,
+            0.3534449338912964,
+            0.00861052330583334,
+            0.001009061117656529,
+            0.0009043768513947725
+        ],
+        "tags"=> [
+            "tabby, tabby cat",
+            "tiger cat",
+            "Egyptian cat",
+            "lens cap, lens cover",
+            "cup"
+        ]
+    }
+}
+```
+
+The default image classifier knows one thousand objects and returns the top 5 most likely results.
+
+### Configure Rails application
 
 If you use Rails, you can add omit the first two lines and add the API key to your environment config file as follows:
 
@@ -39,6 +66,57 @@ If you use Rails, you can add omit the first two lines and add the API key to yo
 config.twentybn_api_key = 'PUT_API_KEY_HERE'
 ```
 
+### Using alternative image classifiers
+
+There are also two alternative image classifiers available, `:categories` and `:places`. You can use them as follows:
+
+```ruby
+tags = TwentyBN.image("/path/to/an/image.jpg").tag(:categories)
+```
+
+```ruby
+tags = TwentyBN.image("/path/to/an/image.jpg").tag(:places)
+```
+
+### Roll your own classifier
+
+You can train your own image classifier at https://cortex.twentyn.com under `Applications` -> `Image Tagging` -> `Custom Image Taggers`. Here, you can create a classifier, add class labels to it and upload some example images for each class. Finally, you can click `train` to build your own classifier automatically. As a result, you get a `ModelID` which you can use to access your custom image classifier as follows:
+
+```ruby
+tags = TwentyBN.image("/path/to/an/image.jpg").tag("PUT_YOUR_MODEL_ID_HERE")
+```
+
+### Visual Question Answering (VQA)
+
+Visual Question Answering means that you can ask a natural language question about a given image. You can use it as follows:
+
+```ruby
+answer = TwentyBN.image("/path/to/an/image.jpg").ask("What is the man doing?")
+```
+
+The result will look like this:
+
+```ruby
+{
+    "result"=> {
+        "answers"=> [
+            "PLAYING FRISBEE",
+            "CATCHING FRISBEE",
+            "FLYING KITE",
+            "FLYING KITES"
+            "SKATEBOARDING",
+        ],
+        "scores"=> [
+            9.731609344482422,
+            8.681315422058105,
+            7.385936737060547,
+            7.113564491271973,
+            6.711164474487305
+        ]
+    }
+}
+```
+
 ## License
 
 Copyright (c) 2016 Twenty Billion Neurons GmbH, Berlin, Germany

data/lib/twentybn/image.rb

@@ -29,7 +29,7 @@ module TwentyBN
         request.url '/v1/vqa'
         request.body = JSON.generate(data)
       end
-      return response.body
+      return JSON.parse(response.body)
     end
 
     def tag(model=:objects)
@@ -49,7 +49,7 @@ module TwentyBN
         end
         request.body = JSON.generate(data)
       end
-      return response.body
+      return JSON.parse(response.body)
     end
 
     def image_base64

data/lib/twentybn/version.rb

@@ -1,3 +1,3 @@
 module TwentyBN
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/twentybn/image_test.rb

@@ -8,7 +8,7 @@ class ImageTest < Minitest::Test
     VCR.use_cassette('tag_objects') do
 
       response = TwentyBN.image("./test/fixtures/files/test_image.jpg").tag
-      result = JSON.parse(response)['result']
+      result = response['result']
 
       tag_result_fixture = YAML.load_file('./test/fixtures/results.yml')['tag_objects_result']
 
@@ -21,7 +21,7 @@ class ImageTest < Minitest::Test
     VCR.use_cassette('tag_places') do
 
       response = TwentyBN.image("./test/fixtures/files/test_image.jpg").tag(:places)
-      result = JSON.parse(response)['result']
+      result = response['result']
 
       tag_result_fixture = YAML.load_file('./test/fixtures/results.yml')['tag_places_result']
 
@@ -34,7 +34,7 @@ class ImageTest < Minitest::Test
     VCR.use_cassette('tag_categories') do
 
       response = TwentyBN.image("./test/fixtures/files/test_image.jpg").tag(:categories)
-      result = JSON.parse(response)['result']
+      result = response['result']
 
       tag_result_fixture = YAML.load_file('./test/fixtures/results.yml')['tag_categories_result']
 
@@ -47,7 +47,7 @@ class ImageTest < Minitest::Test
     VCR.use_cassette('tag_custom') do
 
       response = TwentyBN.image("./test/fixtures/files/test_image.jpg").tag("9b80ddb9-2d02-436f-86ba-f9a3e679de7a")
-      result = JSON.parse(response)['result']
+      result = response['result']
 
       tag_result_fixture = YAML.load_file('./test/fixtures/results.yml')['tag_custom_result']
 
@@ -61,7 +61,7 @@ class ImageTest < Minitest::Test
 
       question = "What is the dog doing?"
       response = TwentyBN.image("./test/fixtures/files/test_image.jpg").ask(question)
-      result = JSON.parse(response)['result']
+      result = response['result']
 
       ask_result_fixture = YAML.load_file('./test/fixtures/results.yml')['ask_result']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twentybn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ingo Bax
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler