update docstring (#151)

Author: AHReccese

pymilo/chains/clustering_chain.py

@@ -51,7 +51,7 @@ def transport_clusterer(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn clustering model
     """
@@ -105,7 +105,7 @@ def deserialize_clusterer(clusterer, is_inner_model=False):
 
     :param clusterer: given json string of a clustering model to get deserialized to associated sklearn clustering model
     :type clusterer: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn clustering model
     """

pymilo/chains/decision_tree_chain.py

@@ -46,7 +46,7 @@ def transport_decision_tree(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn decision tree model
     """
@@ -100,7 +100,7 @@ def deserialize_decision_tree(decision_tree, is_inner_model=False):
 
     :param decision_tree: given json string of a decision tree model to get deserialized to associated sklearn decision tree model
     :type decision_tree: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn decision tree model
     """

pymilo/chains/ensemble_chain.py

@@ -76,7 +76,7 @@ def transport_ensemble(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner ensemble model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn ensemble model
     """

pymilo/chains/linear_model_chain.py

@@ -58,9 +58,9 @@ def transport_linear_model(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
-    :return: the transported request as a json string or sklearn linear model
+    :return: the transported request as a json string or sklearn model
     """
     if not is_inner_model:
         validate_input(request, command)
@@ -119,7 +119,7 @@ def deserialize_linear_model(linear_model, is_inner_model):
 
     :param linear_model: given json string of a linear model to get deserialized to associated sklearn linear model
     :type linear_model: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn linear model
     """

pymilo/chains/naive_bayes_chain.py

@@ -41,7 +41,7 @@ def transport_naive_bayes(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn naive bayes model
     """
@@ -95,7 +95,7 @@ def deserialize_naive_bayes(naive_bayes, is_inner_model=False):
 
     :param naive bayes: given json string of a naive bayes model to get deserialized to associated sklearn naive bayes model
     :type naive bayes: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn naive bayes model
     """

pymilo/chains/neighbours_chain.py

@@ -43,7 +43,7 @@ def transport_neighbor(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn neighbors model
     """
@@ -97,7 +97,7 @@ def deserialize_neighbor(neighbor, is_inner_model=False):
 
     :param neighbor: given json string of a neighbor model to get deserialized to associated sklearn neighbors model
     :type neighbor: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn neighbor model
     """

pymilo/chains/neural_network_chain.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""PyMilo chain for linear models."""
+"""PyMilo chain for neural network models."""
 from ..transporters.transporter import Command
 
 from ..transporters.general_data_structure_transporter import GeneralDataStructureTransporter
@@ -49,7 +49,7 @@ def transport_neural_network(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn neural network model
     """
@@ -103,7 +103,7 @@ def deserialize_neural_network(neural_network, is_inner_model=False):
 
     :param neural_network: given json string of a neural network model to get deserialized to associated sklearn NN model
     :type neural_network: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn NN model
     """

pymilo/chains/svm_chain.py

@@ -43,7 +43,7 @@ def transport_svm(request, command, is_inner_model=False):
     :type request: any object
     :param command: command to specify whether the request should be serialized or deserialized
     :type command: transporter.Command
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: the transported request as a json string or sklearn svm model
     """
@@ -97,7 +97,7 @@ def deserialize_svm(svm, is_inner_model=False):
 
     :param svm: given json string of a svm model to get deserialized to associated sklearn svm model
     :type svm: obj
-    :param is_inner_model: determines whether it is an inner linear model of a super ml model
+    :param is_inner_model: determines whether it is an inner model of a super ml model
     :type is_inner_model: boolean
     :return: associated sklearn svm model
     """