diff --git a/docs/development.rst b/docs/development.rst index 221bdcc..5def52e 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -2,11 +2,7 @@ Developing new services ----------------------- Developing web services can be hard. -To illustrate it, the figure below summarizes the typical features in a text analysis service. - -.. image:: senpy-framework.png - :width: 60% - :align: center +A text analysis service must implement all the typical features, such as: extraction of parameters, validation, format conversion, visualization... Senpy implements all the common blocks, so developers can focus on what really matters: great analysis algorithms that solve real problems. Among other things, Senpy takes care of these tasks: @@ -24,4 +20,5 @@ Sharing your sentiment analysis with the world has never been easier! :maxdepth: 1 plugins-quickstart - plugins-faq \ No newline at end of file + plugins-faq + plugins-definition diff --git a/docs/examples.rst b/docs/examples.rst index a00d171..0e04f4a 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -26,20 +26,7 @@ Representation ,,,,,,,,,,,,,, .. literalinclude:: examples/results/example-sentiment.json - :emphasize-lines: 5-10,25-33 - :language: json-ld - -Suggestion Mining -................. -Description -,,,,,,,,,,, -The suggestions schema represented below shows the suggestions detected in the text. Within it, we can find the NIF fields highlighted that corresponds to the text of the detected suggestion. - -Representation -,,,,,,,,,,,,,, - -.. literalinclude:: examples/results/example-suggestion.json - :emphasize-lines: 5-8,22-27 + :emphasize-lines: 5-11,20-30 :language: json-ld Emotion Analysis @@ -53,28 +40,6 @@ Representation .. literalinclude:: examples/results/example-emotion.json :language: json-ld - :emphasize-lines: 5-8,25-37 - -Named Entity Recognition -........................ -Description -,,,,,,,,,,, -The Named Entity Recognition is represented as follows. In this particular case, it can be seen within the entities array the entities recognised. For the example input, Microsoft and Windows Phone are the ones detected. -Representation -,,,,,,,,,,,,,, - -.. literalinclude:: examples/results/example-ner.json - :emphasize-lines: 5-8,19-34 - :language: json-ld + :emphasize-lines: 5-11,22-36 -Complete example -................ -Description -,,,,,,,,,,, -This example covers all of the above cases, integrating all the annotations in the same document. -Representation -,,,,,,,,,,,,,, - -.. literalinclude:: examples/results/example-complete.json - :language: json-ld diff --git a/docs/examples/results/example-emotion.json b/docs/examples/results/example-emotion.json index 9547302..3185210 100644 --- a/docs/examples/results/example-emotion.json +++ b/docs/examples/results/example-emotion.json @@ -17,10 +17,6 @@ "nif:Context" ], "nif:isString": "Dear Microsoft, put your Windows Phone on your newest #open technology program. You'll be awesome. #opensource", - "entities": [ - ], - "suggestions": [ - ], "sentiments": [ ], "emotions": [ diff --git a/docs/examples/results/example-sentiment.json b/docs/examples/results/example-sentiment.json index 4fe910b..78454c0 100644 --- a/docs/examples/results/example-sentiment.json +++ b/docs/examples/results/example-sentiment.json @@ -17,10 +17,6 @@ "nif:Context" ], "nif:isString": "Dear Microsoft, put your Windows Phone on your newest #open technology program. You'll be awesome. #opensource", - "entities": [ - ], - "suggestions": [ - ], "sentiments": [ { "@id": "http://micro.blog/status1#char=80,97", @@ -32,7 +28,7 @@ "prov:wasGeneratedBy": "_:SAnalysis1_Activity" } ], - "emotionSets": [ + "emotions": [ ] } ] diff --git a/docs/plugins-faq.rst b/docs/plugins-faq.rst index 882dc52..bfc5967 100644 --- a/docs/plugins-faq.rst +++ b/docs/plugins-faq.rst @@ -8,7 +8,7 @@ F.A.Q. What are annotations? ##################### They are objects just like entries. -Senpy ships with several default annotations, including: ``Sentiment``, ``Emotion``, ``EmotionSet``...jk bb +Senpy ships with several default annotations, including ``Sentiment`` and ``Emotion``. What's a plugin made of?