Commit 79d6b6f6 authored by J. Fernando Sánchez's avatar J. Fernando Sánchez

Added plugins FAQ to the docs

parent b8993f7d
Developing new plugins
See the examples at: `<>`_.
Plugins Interface
The basic methods in a plugin are:
* __init__
* activate: used to load memory-hungry resources
* deactivate: used to free up resources
Plugins are loaded asynchronously, so don't worry if the activate method takes too long. The plugin will be marked as activated once it is finished executing the method.
If I'm using a classifier, where should I train the classifier?
Training a classifier can be time time consuming. To avoid running the training unnecessarily, you can use ShelfMixin to store the classifier. For instance:
.. code:: python
from senpy.plugins import ShelfMixin, SenpyPlugin
class MyPlugin(ShelfMixin, SenpyPlugin):
def train(self):
''' Code to train the classifier
# Here goes the code
# ...
return classifier
def activate(self):
if 'classifier' not in
classifier = self.train()['classifier'] = classifier
self.classifier =['classifier']
def deactivate(self):
You can speficy a 'shelf_file' in your .senpy file. By default the ShelfMixin creates a file based on the plugin name and stores it in that plugin's folder.
Where can I find more code examples?
See: `<>`_.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment