bug fix

GiulioRossetti · May 29, 2017 · f9ec870 · f9ec870
1 parent e2967be
commit f9ec870
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 19 deletions.
diff --git a/docs/reference/models/epidemics/SIR.rst b/docs/reference/models/epidemics/SIR.rst
@@ -13,9 +13,28 @@ SIR assumes that if, during a generic iteration, a susceptible node comes into c
 .. autoclass:: ndlib.models.epidemics.SIRModel.SIRModel
 .. automethod:: ndlib.models.epidemics.SIRModel.SIRModel.__init__(graph)
 
-=======
+
+----------
+Parameters
+----------
+
+=====  =====  ===============  =======  =========  =====================
+Name   Type   Value Type       Default  Mandatory  Description
+=====  =====  ===============  =======  =========  =====================
+beta   Model  float in [0, 1]           True       Infection probability
+gamma  Model  float in [0, 1]           True       Removal probability
+=====  =====  ===============  =======  =========  =====================
+
+The initial infection status can be defined via:
+
+    - **percentage_infected**: Model Parameter, float in [0, 1]
+    - **Infected**: Status Parameter, set of nodes
+
+The two options are mutually exclusive and the latter takes precedence over the former.
+
+-------
 Example
-=======
+-------
 
 In the code below is shown an example of istantiation and execution of an SIR simultion on a random graph: we set the initial set of infected nodes as 5% of the overall population, a probability of infection of 1%, and a removal probability of 0.5%.
 

diff --git a/docs/reference/models/epidemics/SIS.rst b/docs/reference/models/epidemics/SIS.rst
@@ -13,9 +13,27 @@ SIS assumes that if, during a generic iteration, a susceptible node comes into c
 .. autoclass:: ndlib.models.epidemics.SISModel.SISModel
 .. automethod:: ndlib.models.epidemics.SISModel.SISModel.__init__(graph)
 
-=======
+----------
+Parameters
+----------
+
+======  =====  ===============  =======  =========  =====================
+Name    Type   Value Type       Default  Mandatory  Description
+======  =====  ===============  =======  =========  =====================
+beta    Model  float in [0, 1]           True       Infection probability
+lambda  Model  float in [0, 1]           True       Recovery probability
+======  =====  ===============  =======  =========  =====================
+
+The initial infection status can be defined via:
+
+    - **percentage_infected**: Model Parameter, float in [0, 1]
+    - **Infected**: Status Parameter, set of nodes
+
+The two options are mutually exclusive and the latter takes precedence over the former.
+
+-------
 Example
-=======
+-------
 
 In the code below is shown an example of istantiation and execution of an SIS simultion on a random graph: we set the initial set of infected nodes as 5% of the overall population, a probability of infection of 1%, and a probability of recovery of 0.5%.
 

diff --git a/docs/reference/models/epidemics/SIm.rst b/docs/reference/models/epidemics/SIm.rst
@@ -13,9 +13,26 @@ SI assumes that if, during a generic iteration, a susceptible node comes into co
 .. autoclass:: ndlib.models.epidemics.SIModel.SIModel
 .. automethod:: ndlib.models.epidemics.SIModel.SIModel.__init__(graph)
 
-=======
+----------
+Parameters
+----------
+
+=====  =====  ===============  =======  =========  =====================
+Name   Type   Value Type       Default  Mandatory  Description
+=====  =====  ===============  =======  =========  =====================
+beta   Model  float in [0, 1]           True       Infection probability
+=====  =====  ===============  =======  =========  =====================
+
+The initial infection status can be defined via:
+
+    - **percentage_infected**: Model Parameter, float in [0, 1]
+    - **Infected**: Status Parameter, set of nodes
+
+The two options are mutually exclusive and the latter takes precedence over the former.
+
+-------
 Example
-=======
+-------
 
 In the code below is shown an example of istantiation and execution of an SI simultion on a random graph: we set the initial set of infected nodes as 5% of the overall population and a probability of infection of 1%.
 

diff --git a/ndlib/models/DiffusionModel.py b/ndlib/models/DiffusionModel.py
@@ -16,8 +16,9 @@ class DiffusionModel(object):
 
     def __init__(self, graph):
         """
+            Model Constructor
 
-        :rtype: object
+            :param graph: A networkx graph object
         """
         self.discrete_state = True
 

diff --git a/ndlib/models/epidemics/IndependentCascadesModel.py b/ndlib/models/epidemics/IndependentCascadesModel.py
@@ -18,7 +18,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/KerteszThresholdModel.py b/ndlib/models/epidemics/KerteszThresholdModel.py
@@ -21,7 +21,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/ProfileModel.py b/ndlib/models/epidemics/ProfileModel.py
@@ -18,7 +18,7 @@ def __init__(self, graph):
         """
         Model Constructor
 
-        :param graph: An networkx graph object
+        :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/ProfileThresholdModel.py b/ndlib/models/epidemics/ProfileThresholdModel.py
@@ -19,7 +19,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/SIModel.py b/ndlib/models/epidemics/SIModel.py
@@ -18,7 +18,7 @@ def __init__(self, graph):
         """
         Model Constructor
 
-        :param graph: An networkx graph object
+        :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/SIRModel.py b/ndlib/models/epidemics/SIRModel.py
@@ -19,7 +19,7 @@ def __init__(self, graph):
         """
          Model Constructor
 
-         :param graph: An networkx graph object
+         :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/SISModel.py b/ndlib/models/epidemics/SISModel.py
@@ -19,7 +19,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/epidemics/ThresholdModel.py b/ndlib/models/epidemics/ThresholdModel.py
@@ -14,6 +14,11 @@ class ThresholdModel(DiffusionModel):
     """
 
     def __init__(self, graph):
+        """
+            Model Constructor
+
+            :param graph: A networkx graph object
+        """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {
             "Susceptible": 0,

diff --git a/ndlib/models/opinions/CognitiveOpDynModel.py b/ndlib/models/opinions/CognitiveOpDynModel.py
@@ -30,7 +30,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
 

diff --git a/ndlib/models/opinions/MajorityRuleModel.py b/ndlib/models/opinions/MajorityRuleModel.py
@@ -14,7 +14,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/opinions/QVoterModel.py b/ndlib/models/opinions/QVoterModel.py
@@ -17,7 +17,7 @@ def __init__(self, graph):
         """
             Model Constructor
 
-            :param graph: An networkx graph object
+            :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/opinions/SznajdModel.py b/ndlib/models/opinions/SznajdModel.py
@@ -15,7 +15,7 @@ def __init__(self, graph):
         """
         Model Constructor
 
-        :param graph: An networkx graph object
+        :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {

diff --git a/ndlib/models/opinions/VoterModel.py b/ndlib/models/opinions/VoterModel.py
@@ -15,7 +15,7 @@ def __init__(self, graph):
         """
         Model Constructor
 
-        :param graph: An networkx graph object
+        :param graph: A networkx graph object
         """
         super(self.__class__, self).__init__(graph)
         self.available_statuses = {