From 31714506bdadde704a74ecf4534daafbd03efc69 Mon Sep 17 00:00:00 2001 From: Sergey Obukhov Date: Fri, 2 Nov 2018 15:21:36 +0300 Subject: [PATCH] Update Readme with how to retrain on your own data --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 1f8d7e0..6ba6d73 100644 --- a/README.rst +++ b/README.rst @@ -129,6 +129,22 @@ start using it for talon. .. _EDRM: http://www.edrm.net/resources/data-sets/edrm-enron-email-data-set .. _forge: https://github.com/mailgun/forge +Training on your dataset +------------------------ + +talon comes with a pre-processed dataset and a pre-trained classifier. To retrain the classifier on your own dataset of raw emails, structure and annotate them in the same way the `forge`_ project does. Then do: + +.. code:: python + + from talon.signature.learning.dataset import build_extraction_dataset + from talon.signature.learning import classifier as c + + build_extraction_dataset("/path/to/your/P/folder", "/path/to/talon/signature/data/train.data") + c.train(c.init(), "/path/to/talon/signature/data/train.data", "/path/to/talon/signature/data/classifier") + +Note that for signature extraction you need just the folder with the positive samples with annotated signature lines (P folder). + +.. _forge: https://github.com/mailgun/forge Research --------