Skip to content

Commit 989a3ab

Browse files
committedMay 15, 2019
update docs for featurization
1 parent 4b31678 commit 989a3ab

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed
 

‎automatminer/featurization/core.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ class AutoFeaturizer(DFTransformer, LoggableMixin):
5151
from this file instead of featurizing. If this file does not exist,
5252
AutoFeaturizer will featurize normally, then save the features to a
5353
new file. Only features (not featurizer input objects) will be saved
54-
preset (str): "best" or "robust" or "all". Determines by preset the
55-
featurizers that should be applied. See the Featurizer sets for
56-
specifics of best/robust/all. Default is "best". Incompatible with
54+
preset (str): "express" or "heavy" or "debug" or "all. Determines by
55+
preset the featurizers that should be applied. See the Featurizer
56+
sets for specifics of each. Default is "express". Incompatible with
5757
the featurizers arg.
5858
featurizers (dict): Use this option if you want to manually specify
5959
the featurizers to use. Keys are the featurizer types you want
@@ -118,15 +118,16 @@ def __init__(self, cache_src=None, preset=None, featurizers=None,
118118

119119
if featurizers and preset:
120120
raise AutomatminerError("Featurizers and preset were both set. "
121-
"Please either use a preset ('best', 'all',"
122-
" 'robust') or set featurizers manually.")
121+
"Please either use a preset ('express', "
122+
"'all', 'debug', 'heavy') or set "
123+
"featurizers manually.")
123124
if not featurizers and not preset:
124125
raise AutomatminerError("Please specify set(s) of featurizers to "
125126
"use either through the featurizers"
126127
"argument or through the preset argument.")
127128

128129
self.cache_src = cache_src
129-
self.preset = "best" if preset is None else preset
130+
self.preset = "express" if preset is None else preset
130131
self._logger = self.get_logger(logger)
131132
self.featurizers = featurizers
132133
self.exclude = exclude if exclude else []

‎automatminer/featurization/sets.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Defines sets of featurizers to be used by automatminer during featurization.
33
44
Featurizer sets are classes with attributes containing lists of featurizers.
5-
For example, the set of all robust structure featurizers could be found with::
5+
For example, the set of all express structure featurizers could be found with::
66
77
StructureFeaturizers().express
88
"""
@@ -245,7 +245,7 @@ class BSFeaturizers(FeaturizerSet):
245245
246246
Example usage::
247247
248-
bs_featurizers = BSFeaturizers().best
248+
bs_featurizers = BSFeaturizers().express
249249
250250
Args:
251251
exclude (list of str, optional): A list of featurizer class names that
@@ -279,7 +279,7 @@ class AllFeaturizers(FeaturizerSet):
279279
280280
This class provides subsets for composition, structure, density of states
281281
and band structure based featurizers. Additional sets containing all
282-
featurizers and the set of best featurizers are provided.
282+
featurizers and the set of express/heavy/etc. featurizers are provided.
283283
284284
Example usage::
285285

0 commit comments

Comments
 (0)
Please sign in to comment.