Skip to content

Commit

Permalink
simplifying options, updating docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jonrkarr committed Apr 19, 2018
1 parent 890aae2 commit 02e3d5c
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions wc_model_gen/core.py
Expand Up @@ -17,29 +17,27 @@ class ModelGenerator(object):
""" Generating a model instance (:obj:`wc_lang.Model`)
Attributes:
component_generators (:obj:`list` of :obj:`ModelComponentGenerator`): model component generators
options (:obj:`dict`, optional): dictionary of options whose keys are methods and values are
optional arguments to the methods
knowledge_base (:obj:`wc_kb.KnowledgeBase`): knowledge base
components (:obj:`list` of :obj:`ModelComponentGenerator`): model component generators
options (:obj:`dict`, optional): options
"""

DEFAULT_COMPONENTS = () # todo: run default components

def __init__(self, knowledge_base, components=None, options=None):
"""
Args:
component_generators (:obj:`tuple` of :obj:`ModelComponentGenerator`): model component generators
options (:obj:`dict`, optional): dictionary of options whose keys are method names and values are
optional arguments to the methods
knowledge_base (:obj:`wc_kb.KnowledgeBase`): knowledge base
component_generators (:obj:`tuple` of :obj:`ModelComponentGenerator`, optional): model component generators
options (:obj:`dict`, optional): options
"""

self.knowledge_base = knowledge_base
self.components = components or self.DEFAULT_COMPONENTS
self.options = options or {}

def run(self, id=None, version=None):
""" Generate a wc_lang model from a :obj:`wc_kb` knowledge base
Args:
id (:obj:`str`): model id
def run(self):
""" Generate a :obj:`wc_lang` model from a :obj:`wc_kb` knowledge base
Returns:
:obj:`wc_lang.Model`: model
Expand All @@ -64,14 +62,15 @@ class ModelComponentGenerator(six.with_metaclass(abc.ABCMeta, object)):
Attributes:
knowledge_base (:obj:`wc_kb.KnowledgeBase`): knowledge base
model (:obj:`wc_lang.Model`): model
options (:obj:`dict`, optional): options
"""

def __init__(self, knowledge_base, model, options=None):
"""
Args:
knowledge_base (:obj:`wc_kb.KnowledgeBase`): knowledge base
model (:obj:`wc_lang.Model`): model
model (:obj:`dict`, optional): options
options (:obj:`dict`, optional): options
"""
self.knowledge_base = knowledge_base
self.model = model
Expand Down

0 comments on commit 02e3d5c

Please sign in to comment.