Multiple changes in the API, schemas and UI

Check out the CHANGELOG.md file for more information

example-plugins/README.md

@@ -1,6 +1,6 @@
 This is a collection of plugins that exemplify certain aspects of plugin development with senpy.
 
-The first series of plugins the `basic` ones.
+The first series of plugins are the `basic` ones.
 Their starting point is a classification function defined in `basic.py`.
 They all include testing and running them as a script will run all tests.
 In ascending order of customization, the plugins are:
@@ -19,5 +19,5 @@ In rest of the plugins show advanced topics:
 
 All of the plugins in this folder include a set of test cases and they are periodically tested with the latest version of senpy.
 
-Additioanlly, for an example of stand-alone plugin that can be tested and deployed with docker, take a look at: lab.cluster.gsi.dit.upm.es/senpy/plugin-example
+Additioanlly, for an example of stand-alone plugin that can be tested and deployed with docker, take a look at: lab.gsi.upm.es/senpy/plugin-example
  bbm

example-plugins/basic.py

@@ -1,5 +1,5 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 emoticons = {
     'pos': [':)', ':]', '=)', ':D'],
@@ -7,17 +7,19 @@ emoticons = {
 }
 
 emojis = {
-    'pos': ['😁', '😂', '😃', '😄', '😆', '😅', '😄' '😍'],
-    'neg': ['😢', '😡', '😠', '😞', '😖', '😔', '😓', '😒']
+    'pos': [u'😁', u'😂', u'😃', u'😄', u'😆', u'😅', u'😄', u'😍'],
+    'neg': [u'😢', u'😡', u'😠', u'😞', u'😖', u'😔', u'😓', u'😒']
 }
 
 
 def get_polarity(text, dictionaries=[emoticons, emojis]):
     polarity = 'marl:Neutral'
+    print('Input for get_polarity', text)
     for dictionary in dictionaries:
         for label, values in dictionary.items():
             for emoticon in values:
                 if emoticon and emoticon in text:
                     polarity = label
                     break
+    print('Polarity', polarity)
     return polarity

example-plugins/basic_analyse_entry_plugin.py

@@ -1,5 +1,5 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 from senpy import easy_test, models, plugins
 
@@ -18,13 +18,13 @@ class BasicAnalyseEntry(plugins.SentimentPlugin):
         'default': 'marl:Neutral'
     }
 
-    def analyse_entry(self, entry, params):
+    def analyse_entry(self, entry, activity):
         polarity = basic.get_polarity(entry.text)
 
         polarity = self.mappings.get(polarity, self.mappings['default'])
 
         s = models.Sentiment(marl__hasPolarity=polarity)
-        s.prov(self)
+        s.prov(activity)
         entry.sentiments.append(s)
         yield entry
 

example-plugins/basic_box_plugin.py

@@ -1,5 +1,5 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 from senpy import easy_test, SentimentBox
 
@@ -12,15 +12,13 @@ class BasicBox(SentimentBox):
     author = '@balkian'
     version = '0.1'
 
-    mappings = {
-        'pos': 'marl:Positive',
-        'neg': 'marl:Negative',
-        'default': 'marl:Neutral'
-    }
-
-    def predict_one(self, input):
-        output = basic.get_polarity(input)
-        return self.mappings.get(output, self.mappings['default'])
+    def predict_one(self, features, **kwargs):
+        output = basic.get_polarity(features[0])
+        if output == 'pos':
+            return [1, 0, 0]
+        if output == 'neg':
+            return [0, 0, 1]
+        return [0, 1, 0]
 
     test_cases = [{
         'input': 'Hello :)',

example-plugins/basic_plugin.py

@@ -1,37 +1,36 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
-from senpy import easy_test, SentimentBox, MappingMixin
+from senpy import easy_test, SentimentBox
 
 import basic
 
 
-class Basic(MappingMixin, SentimentBox):
+class Basic(SentimentBox):
     '''Provides sentiment annotation using a lexicon'''
 
     author = '@balkian'
     version = '0.1'
 
-    mappings = {
-        'pos': 'marl:Positive',
-        'neg': 'marl:Negative',
-        'default': 'marl:Neutral'
-    }
-
-    def predict_one(self, input):
-        return basic.get_polarity(input)
+    def predict_one(self, features, **kwargs):
+        output = basic.get_polarity(features[0])
+        if output == 'pos':
+            return [1, 0, 0]
+        if output == 'neu':
+            return [0, 1, 0]
+        return [0, 0, 1]
 
     test_cases = [{
-        'input': 'Hello :)',
+        'input': u'Hello :)',
         'polarity': 'marl:Positive'
     }, {
-        'input': 'So sad :(',
+        'input': u'So sad :(',
         'polarity': 'marl:Negative'
     }, {
-        'input': 'Yay! Emojis  😁',
+        'input': u'Yay! Emojis  😁',
         'polarity': 'marl:Positive'
     }, {
-        'input': 'But no emoticons 😢',
+        'input': u'But no emoticons 😢',
         'polarity': 'marl:Negative'
     }]
 

example-plugins/configurable_plugin.py

@@ -1,5 +1,5 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 from senpy import easy_test, models, plugins
 
@@ -16,7 +16,7 @@ class Dictionary(plugins.SentimentPlugin):
 
     mappings = {'pos': 'marl:Positive', 'neg': 'marl:Negative'}
 
-    def analyse_entry(self, entry, params):
+    def analyse_entry(self, entry, *args, **kwargs):
         polarity = basic.get_polarity(entry.text, self.dictionaries)
         if polarity in self.mappings:
             polarity = self.mappings[polarity]

example-plugins/emorand_plugin.py

@@ -0,0 +1,33 @@
+import random
+
+from senpy.plugins import EmotionPlugin
+from senpy.models import EmotionSet, Emotion, Entry
+
+
+class EmoRand(EmotionPlugin):
+    '''A sample plugin that returns a random emotion annotation'''
+    name = 'emotion-random'
+    author = '@balkian'
+    version = '0.1'
+    url = "https://github.com/gsi-upm/senpy-plugins-community"
+    onyx__usesEmotionModel = "emoml:big6"
+
+    def analyse_entry(self, entry, activity):
+        category = "emoml:big6happiness"
+        number = max(-1, min(1, random.gauss(0, 0.5)))
+        if number > 0:
+            category = "emoml:big6anger"
+        emotionSet = EmotionSet()
+        emotion = Emotion({"onyx:hasEmotionCategory": category})
+        emotionSet.onyx__hasEmotion.append(emotion)
+        emotionSet.prov(activity)
+        entry.emotions.append(emotionSet)
+        yield entry
+
+    def test(self):
+        params = dict()
+        results = list()
+        for i in range(100):
+            res = next(self.analyse_entry(Entry(nif__isString="Hello"), self.activity(params)))
+            res.validate()
+            results.append(res.emotions[0]['onyx:hasEmotion'][0]['onyx:hasEmotionCategory'])

example-plugins/parameterized_plugin.py

@@ -1,5 +1,5 @@
 #!/usr/local/bin/python
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 from senpy import easy_test, models, plugins
 
@@ -25,7 +25,8 @@ class ParameterizedDictionary(plugins.SentimentPlugin):
         }
     }
 
-    def analyse_entry(self, entry, params):
+    def analyse_entry(self, entry, activity):
+        params = activity.params
         positive_words = params['positive-words'].split(',')
         negative_words = params['negative-words'].split(',')
         dictionary = {
@@ -35,7 +36,7 @@ class ParameterizedDictionary(plugins.SentimentPlugin):
         polarity = basic.get_polarity(entry.text, [dictionary])
 
         s = models.Sentiment(marl__hasPolarity=polarity)
-        s.prov(self)
+        s.prov(activity)
         entry.sentiments.append(s)
         yield entry
 

example-plugins/rand_plugin.py

@@ -0,0 +1,38 @@
+import random
+from senpy import SentimentPlugin, Sentiment, Entry
+
+
+class RandSent(SentimentPlugin):
+    '''A sample plugin that returns a random sentiment annotation'''
+    name = 'sentiment-random'
+    author = "@balkian"
+    version = '0.1'
+    url = "https://github.com/gsi-upm/senpy-plugins-community"
+    marl__maxPolarityValue = '1'
+    marl__minPolarityValue = "-1"
+
+    def analyse_entry(self, entry, activity):
+        polarity_value = max(-1, min(1, random.gauss(0.2, 0.2)))
+        polarity = "marl:Neutral"
+        if polarity_value > 0:
+            polarity = "marl:Positive"
+        elif polarity_value < 0:
+            polarity = "marl:Negative"
+        sentiment = Sentiment(marl__hasPolarity=polarity,
+                              marl__polarityValue=polarity_value)
+        sentiment.prov(activity)
+        entry.sentiments.append(sentiment)
+        yield entry
+
+    def test(self):
+        '''Run several random analyses.'''
+        params = dict()
+        results = list()
+        for i in range(50):
+            activity = self.activity(params)
+            res = next(self.analyse_entry(Entry(nif__isString="Hello"),
+                                          activity))
+            res.validate()
+            results.append(res.sentiments[0]['marl:hasPolarity'])
+        assert 'marl:Positive' in results
+        assert 'marl:Negative' in results

example-plugins/sklearn/pipeline_plugin.py

@@ -1,25 +1,20 @@
-from senpy import SentimentBox, MappingMixin, easy_test
+from senpy import SentimentBox, easy_test
 
 from mypipeline import pipeline
 
 
-class PipelineSentiment(MappingMixin, SentimentBox):
-    '''
-    This is a pipeline plugin that wraps a classifier defined in another module
-    (mypipeline).
-    '''
+class PipelineSentiment(SentimentBox):
+    '''This is a pipeline plugin that wraps a classifier defined in another module
+(mypipeline).'''
     author = '@balkian'
     version = 0.1
     maxPolarityValue = 1
     minPolarityValue = -1
 
-    mappings = {
-        1: 'marl:Positive',
-        -1: 'marl:Negative'
-    }
-
-    def predict_one(self, input):
-        return pipeline.predict([input, ])[0]
+    def predict_one(self, features, **kwargs):
+        if pipeline.predict(features) > 0:
+            return [1, 0, 0]
+        return [0, 0, 1]
 
     test_cases = [
         {