From 70da8f79250955ef5a69a4fdd063a472aeef1147 Mon Sep 17 00:00:00 2001
From: Alex Moreo <alejandro.moreo@isti.cnr.it>
Date: Tue, 16 Feb 2021 19:38:52 +0100
Subject: [PATCH] updating the documentation

---
 quapy/__init__.py                |  1 +
 quapy/classification/__init__.py |  1 +
 quapy/classification/svmperf.py  |  2 ++
 quapy/method/aggregative.py      | 35 +++++++++++++++++++++++++-------
 4 files changed, 32 insertions(+), 7 deletions(-)

diff --git a/quapy/__init__.py b/quapy/__init__.py
index 00fceb1..cffae1c 100644
--- a/quapy/__init__.py
+++ b/quapy/__init__.py
@@ -18,6 +18,7 @@ environ = {
     'UNK_INDEX': 0,
     'PAD_TOKEN': '[PAD]',
     'PAD_INDEX': 1,
+    'SVMPERF_HOME': './svm_perf_quantification'
 }
 
 def isbinary(x):
diff --git a/quapy/classification/__init__.py b/quapy/classification/__init__.py
index e69de29..7aa5c77 100644
--- a/quapy/classification/__init__.py
+++ b/quapy/classification/__init__.py
@@ -0,0 +1 @@
+from . import svmperf
\ No newline at end of file
diff --git a/quapy/classification/svmperf.py b/quapy/classification/svmperf.py
index 38cf6c6..5202b4e 100644
--- a/quapy/classification/svmperf.py
+++ b/quapy/classification/svmperf.py
@@ -16,11 +16,13 @@ class SVMperf(BaseEstimator, ClassifierMixin):
     valid_losses = {'01':0, 'f1':1, 'kld':12, 'nkld':13, 'q':22, 'qacc':23, 'qf1':24, 'qgm':25, 'mae':26, 'mrae':27}
 
     def __init__(self, svmperf_base, C=0.01, verbose=False, loss='01'):
+        assert exists(svmperf_base), f'path {svmperf_base} does not seem to point to a valid path'
         self.svmperf_base = svmperf_base
         self.C = C
         self.verbose = verbose
         self.loss = loss
 
+
     def set_params(self, **parameters):
         assert list(parameters.keys()) == ['C'], 'currently, only the C parameter is supported'
         self.C = parameters['C']
diff --git a/quapy/method/aggregative.py b/quapy/method/aggregative.py
index 67d47bd..0d8b2f3 100644
--- a/quapy/method/aggregative.py
+++ b/quapy/method/aggregative.py
@@ -323,6 +323,12 @@ class PACC(AggregativeProbabilisticQuantifier):
 
 
 class EMQ(AggregativeProbabilisticQuantifier):
+    """
+    The method is described in:
+    Saerens, M., Latinne, P., and Decaestecker, C. (2002).
+    Adjusting the outputs of a classifier to new a priori probabilities: A simple procedure.
+    Neural Computation, 14(1): 21–41.
+    """
 
     MAX_ITER = 1000
     EPSILON = 1e-4
@@ -440,8 +446,8 @@ class HDy(AggregativeProbabilisticQuantifier, BinaryQuantifier):
 
 class ELM(AggregativeQuantifier, BinaryQuantifier):
 
-    def __init__(self, svmperf_base, loss, **kwargs):
-        self.svmperf_base = svmperf_base
+    def __init__(self, svmperf_base=None, loss='01', **kwargs):
+        self.svmperf_base = svmperf_base if svmperf_base is not None else qp.environ['SVMPERF_HOME']
         self.loss = loss
         self.kwargs = kwargs
         self.learner = SVMperf(self.svmperf_base, loss=self.loss, **self.kwargs)
@@ -461,27 +467,42 @@ class ELM(AggregativeQuantifier, BinaryQuantifier):
 
 
 class SVMQ(ELM):
-    def __init__(self, svmperf_base, **kwargs):
+    """
+    Barranquero, J., Díez, J., and del Coz, J. J. (2015).
+    Quantification-oriented learning based on reliable classifiers.
+    Pattern Recognition, 48(2):591–604.
+    """
+    def __init__(self, svmperf_base=None, **kwargs):
         super(SVMQ, self).__init__(svmperf_base, loss='q', **kwargs)
 
 
 class SVMKLD(ELM):
-    def __init__(self, svmperf_base, **kwargs):
+    """
+    Esuli, A. and Sebastiani, F. (2015).
+    Optimizing text quantifiers for multivariate loss functions.
+    ACM Transactions on Knowledge Discovery and Data, 9(4):Article 27.
+    """
+    def __init__(self, svmperf_base=None, **kwargs):
         super(SVMKLD, self).__init__(svmperf_base, loss='kld', **kwargs)
 
 
 class SVMNKLD(ELM):
-    def __init__(self, svmperf_base, **kwargs):
+    """
+    Esuli, A. and Sebastiani, F. (2015).
+    Optimizing text quantifiers for multivariate loss functions.
+    ACM Transactions on Knowledge Discovery and Data, 9(4):Article 27.
+    """
+    def __init__(self, svmperf_base=None, **kwargs):
         super(SVMNKLD, self).__init__(svmperf_base, loss='nkld', **kwargs)
 
 
 class SVMAE(ELM):
-    def __init__(self, svmperf_base, **kwargs):
+    def __init__(self, svmperf_base=None, **kwargs):
         super(SVMAE, self).__init__(svmperf_base, loss='mae', **kwargs)
 
 
 class SVMRAE(ELM):
-    def __init__(self, svmperf_base, **kwargs):
+    def __init__(self, svmperf_base=None, **kwargs):
         super(SVMRAE, self).__init__(svmperf_base, loss='mrae', **kwargs)