balkian/senpy
1
0
Fork 0
mirror of https://github.com/gsi-upm/senpy synced 2024-11-24 17:12:29 +00:00
Code Issues Releases Wiki Activity

Fixed conversion docs

Browse Source
This commit is contained in:
J. Fernando Sánchez 2017-03-01 17:56:17 +01:00
parent 99403b3443
commit 62ddca79ac
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/conversion.rst
View File

@ -1,13 +1,13 @@
Introduction Conversion
------------ ----------
Senpy includes experimental support for emotion/sentiment conversion plugins. Senpy includes experimental support for emotion/sentiment conversion plugins.
Use Use
--- ===
Consider the original query: `http://127.0.0.1:5000/api/?i=hello&algo=emoRand`_ Consider the original query: http://127.0.0.1:5000/api/?i=hello&algo=emoRand
The requested plugin (emoRand) returns emotions using Ekman's model (or big6 in EmotionML): The requested plugin (emoRand) returns emotions using Ekman's model (or big6 in EmotionML):
@ -28,7 +28,7 @@ The requested plugin (emoRand) returns emotions using Ekman's model (or big6 in
To get these emotions in VAD space (FSRE dimensions in EmotionML), we'd do this: To get these emotions in VAD space (FSRE dimensions in EmotionML), we'd do this:
`http://127.0.0.1:5000/api/?i=hello&algo=emoRand&emotionModel=emoml:fsre-dimensions`_ http://127.0.0.1:5000/api/?i=hello&algo=emoRand&emotionModel=emoml:fsre-dimensions
This call, provided there is a valid conversion plugin from Ekman's to VAD, would return something like this: This call, provided there is a valid conversion plugin from Ekman's to VAD, would return something like this:
@ -87,7 +87,7 @@ It is also possible to get the original emotion nested within the new converted
Lastly, `conversion=filtered` would only return the converted emotions. Lastly, `conversion=filtered` would only return the converted emotions.
Developing a conversion plugin Developing a conversion plugin
------------------------------ ================================
Conversion plugins are discovered by the server just like any other plugin. Conversion plugins are discovered by the server just like any other plugin.
The difference is the slightly different API, and the need to specify the `source` and `target` of the conversion. The difference is the slightly different API, and the need to specify the `source` and `target` of the conversion.

6
docs/index.rst
View File

@ -1,8 +1,3 @@
.. Senpy documentation master file, created by
sphinx-quickstart on Tue Feb 24 08:57:32 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Senpy's documentation! Welcome to Senpy's documentation!
================================= =================================
@ -15,5 +10,6 @@ Contents:
api api
schema schema
plugins plugins
conversion
demo demo
:maxdepth: 2 :maxdepth: 2

4
docs/usage.rst
View File

@ -74,3 +74,7 @@ This example shows how to make a request to the default plugin:
.. _section: http://senpy.readthedocs.org/en/latest/api.html .. _section: http://senpy.readthedocs.org/en/latest/api.html
Conversion
==========
See :doc:`conversion`