balkian/senpy
1
0
Fork 0
mirror of https://github.com/gsi-upm/senpy synced 2024-11-22 00:02:28 +00:00
Code Issues Releases Wiki Activity

Added example plugin in docs. #34

Browse Source
This commit is contained in:
militarpancho 2017-06-02 17:39:16 +02:00
parent 0f8d1dff69
commit 69ac95bb08
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/plugins.rst
View File

@ -98,7 +98,7 @@ The value may be any valid JSON-LD dictionary.
For simplicity, senpy includes a series of models by default in the ``senpy.models`` module. For simplicity, senpy includes a series of models by default in the ``senpy.models`` module.
Example plugin Example pluginhttps://lab.cluster.gsi.dit.upm.es/senpy/plugin-prueba
============== ==============
In this section, we will implement a basic sentiment analysis plugin. In this section, we will implement a basic sentiment analysis plugin.
@ -113,7 +113,7 @@ The definition file would look like this:
module: helloworld module: helloworld
version: 0.0 version: 0.0
threshold: 10 threshold: 10
description: Hello World
Now, in a file named ``helloworld.py``: Now, in a file named ``helloworld.py``:
@ -122,11 +122,11 @@ Now, in a file named ``helloworld.py``:
#!/bin/env python #!/bin/env python
#helloworld.py #helloworld.py
from senpy.plugins import SenpyPlugin from senpy.plugins import AnalysisPlugin
from senpy.models import Sentiment from senpy.models import Sentiment
class HelloWorld(SenpyPlugin): class HelloWorld(AnalysisPlugin):
def analyse_entry(entry, params): def analyse_entry(entry, params):
'''Basically do nothing with each entry''' '''Basically do nothing with each entry'''
@ -139,6 +139,8 @@ Now, in a file named ``helloworld.py``:
entry.sentiments.append(sentiment) entry.sentiments.append(sentiment)
yield entry yield entry
A repository with the code of an example plugin adding extra data is available `here <https://lab.cluster.gsi.dit.upm.es/senpy/plugin-prueba>`__
F.A.Q. F.A.Q.
====== ======
@ -166,7 +168,7 @@ Training a classifier can be time time consuming. To avoid running the training
from senpy.plugins import ShelfMixin, SenpyPlugin from senpy.plugins import ShelfMixin, SenpyPlugin
class MyPlugin(ShelfMixin, SenpyPlugin): class MyPlugin(ShelfMixin, AnalysisPlugin):
def train(self): def train(self):
''' Code to train the classifier ''' Code to train the classifier
''' '''
@ -277,7 +279,6 @@ Additionally, with the ``--pdb`` option you will be dropped into a pdb post mort
senpy --pdb senpy --pdb
Where can I find more code examples? Where can I find more code examples?
???????????????????????????????????? ????????????????????????????????????