Skip to content

Commit

Permalink
Minor changes in code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mghasemi committed Mar 6, 2019
1 parent c1023f1 commit 57f9de6
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions SKSurrogate/aml.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ def _check_mid_first(self, o):
def Generate(self, l):
"""
Generates the set of legitimate words of length `l`
:param l: int, the length of words
:return: set of all legitimate words of length `l`
"""
Expand Down Expand Up @@ -316,9 +317,9 @@ class AML(object):
:param cat_cols: default=None; The list of indices of categorical columns
:param surrogates: default=None; A list of 4-tuples determining surrogates. The first entity of each pair is
a scikit-learn regressor and the
2nd entity is the number of iterations that this surrogate needs to be estimated and optimized.
The 3rd is the sampling strategy and the
4th is the `scipy.optimize` solver
2nd entity is the number of iterations that this surrogate needs to be estimated and optimized.
The 3rd is the sampling strategy and the
4th is the `scipy.optimize` solver
:param min_random_evals: default=15; Number of randomly sampled initial values for hyper parameters
:param cv: default=`ShuffleSplit(n_splits=3, test_size=.25); The cross validation method
:param check_point: default='./'; The path where the optimization results will be stored
Expand Down Expand Up @@ -380,6 +381,7 @@ def __init__(self, config=None, length=5, scoring='accuracy', cat_cols=None,
def types(self):
"""
Recognizes the type of each estimator to determine legitimate placement of each
:return: None
"""
from importlib import import_module
Expand Down Expand Up @@ -407,6 +409,7 @@ def types(self):
def _validate_sequence(self, seq):
"""
Validates the structure of the building sequence
:param seq: a sequence of (genes) estimators
:return: True or False
"""
Expand Down

0 comments on commit 57f9de6

Please sign in to comment.