added FunctionFactory improved function, eval_outputs, added fast_compute

compile.py

@@ -2,6 +2,7 @@
 
 import numpy
 import gof
+import sys
 
 #TODO: put together some default optimizations (TRAC #67)
 
@@ -27,7 +28,7 @@ def _mark_indestructible(results):
     for r in results:
         r.indestructible = True
 
-def linker_cls_python_and_c(env):
+def linker_cls_python_and_c(env, **kwargs):
     """Use this as the linker_cls argument to Function.__init__ to compare
     python and C implementations"""
     def checker(x, y):
@@ -38,171 +39,275 @@ def linker_cls_python_and_c(env):
         else:
             if x != y:
                 raise Exception("Output mismatch.", {'performlinker': x, 'clinker': y})
-    return gof.DualLinker(env, checker)
+    return gof.DualLinker(env, checker, **kwargs)
 
 
-class Function:
-    """
-    An 'executable' compiled from a graph
+def infer_reuse_pattern(env, outputs_to_disown):
+    do_not_reuse = list()
+    seen = set()
+    def walk(r):
+        if r.owner is None or r in seen:
+            return
+        seen.add(r)
+        do_not_reuse.append(r)
+        node = r.owner
+        op = node.op
+        dmap = op.destroy_map if hasattr(op, 'destroy_map') else {}
+        vmap = op.view_map if hasattr(op, 'view_map') else {}
+        for l in dmap.values() + vmap.values():
+            for i in l:
+                walk(node.inputs[i])
+    for output in outputs_to_disown:
+        walk(output)
+    return do_not_reuse
 
-    This class is meant to be used as a function: the idea is to use
-    __call__(*args) and it will compute your graph's function on the args and
-    return the value(s) corresponding to the output(s).
-    
-    @ivar fn: the return value of L{linker.make_function}(False)
-
-    Additional Attributes if keep_locals == True
-    inputs - inputs in the env
-    outputs - outputs in the env
-    features - features to add to the env
-    linker_cls - the linker class
-    linker - the linker allocated from env
-    env - The env passed to the linker
-
-    @note: B{Re: Memory ownership, aliasing, re-use:}
-    That the objects returned by L{Function.__call__}(self, *args) are owned
-    by self, and that in general these outputs might be overwritten (in-place)
-    by subsequent calls to L{self.__call__}(*args).  Why?  This behaviour is
-    necessary for inplace operations to work, and L{Function}'s linker might re-use
-    memory from one execution to the next in order to make each execution faster.
-
-    """
-    def __init__(self, inputs, outputs,
-            features = [],
-            optimizer = default_optimizer,
-            linker_cls = gof.link.PerformLinker,
-            profiler = None,
-            unpack_single = True,
-            except_unreachable_input = True,
-            keep_locals = True):
-        """
-        Copy the graph, optimize, and link it.
-
-        @param inputs: a list of results to be this function's inputs
-        @param outputs: a list of results to be this function's outputs
-        @param features: features to add to the env
-        @param optimizer: an optimizer to apply to the copied graph, before linking
-        @param linker_cls: a callable that takes an env and returns a Linker
-        @param profiler: a L{Profiler} for the produced function (only valid if the
-                   linker_cls's make_function takes a profiler argument)
-        @param unpack_single: unpack return value lists of length 1. @see: L{Linker.make_function}
-        @param keep_locals: add the local variables from __init__ to the class
-        """
-
-        _mark_indestructible(outputs)
 
+def cloned_env(inputs, outputs):
+    inputs, outputs = gof.graph.clone(inputs, outputs)
+    env = gof.env.Env(inputs, outputs)
+    return env
+
+def std_env(inputs, outputs):
+    inputs, outputs = gof.graph.clone(inputs, outputs)
+    _mark_indestructible(outputs)
+    env = gof.env.Env(inputs, outputs)
+    env.extend(gof.DestroyHandler())
+    env.extend(gof.ReplaceValidate())
+    return env
+
+def std_opt(env):
+    pass
+
+
+predefined_linkers = {
+    'py'   : gof.link.PerformLinker,
+    'c'    : gof.cc.CLinker,
+    'c|py' : gof.cc.OpWiseCLinker,
+    'c&py' : linker_cls_python_and_c
+    }
+
+class FunctionFactory:
+
+    def __init__(self, inputs, outputs, linker = 'py', optimizer = std_opt, borrow_outputs = False):
         if len(inputs) != len(set(inputs)):
-            raise Exception('duplicate inputs')
-        if len(outputs) != len(set(outputs)):
-            raise Exception('duplicate outputs')
+            print >>sys.stderr, "Warning: duplicate inputs"
+        env = std_env(inputs, outputs)
+        if None is not optimizer:
+            optimizer(env)
+        env.validate()
+        self.env = env
+        linker = predefined_linkers.get(linker, linker)
+        if borrow_outputs:
+            self.linker = linker(env)
+        else:
+            self.linker = linker(env, no_recycling = infer_reuse_pattern(env, env.outputs))
+            
+    def create(self, profiler = None, unpack_single = True):
+        if profiler is None:
+            fn = self.linker.make_function(unpack_single=unpack_single)
+        else:
+            fn  = self.linker.make_function(unpack_single=unpack_single,
+                                            profiler=profiler)
+        return fn
 
-        #evaluate the orphans, and put these values into the clone of the env
+    def partial(self, *first, **kwargs):
+        fn = self.create(**kwargs)
+        return lambda *last: fn(*(first + last))
 
-        orphans = list(gof.graph.results_and_orphans(inputs, outputs,
-            except_unreachable_input=except_unreachable_input)[1])
-        orphan_data = eval_outputs(orphans, unpack_single=False)
 
-        #print 'orphans', orphans
+def function(inputs,
+             outputs,
+             linker = 'py',
+             optimizer = std_opt,
+             borrow_outputs = False,
+             profiler = None,
+             unpack_single = True):
+    ff = FunctionFactory(inputs,
+                         outputs,
+                         linker = linker,
+                         optimizer = optimizer,
+                         borrow_outputs = borrow_outputs,)
+    return ff.create(profiler = profiler,
+                     unpack_single = unpack_single)
 
-        #print 'ops', gof.graph.ops(inputs, outputs)
-        env = gof.env.Env(inputs, outputs)
 
-        #print 'orphans in env', env.orphans()
+def eval_outputs(outputs, **kwargs):
+    return function([], outputs, **kwargs)()
 
-        env, equiv = env.clone_get_equiv(clone_inputs=True)
-        for feature in features:
-            env.extend(feature(env))
-        env.extend(gof.DestroyHandler(env))
 
-        #print 'orphans after clone', env.orphans()
+_fcache = {} # it would be nice to use weakref.WeakKeyDictionary()
 
-        for d, o in zip(orphan_data, [equiv[orphan] for orphan in orphans]):
-            #print 'assigning orphan value', d
-            #o.data = d
-            new_o = gof.Constant(o.type, d)
-            env.replace(o, new_o)
-            assert new_o in env.orphans
+def fast_compute(*outputs):
+    if outputs in _fcache:
+        f = _fcache[outputs]
+    else:
+        f = function([], outputs, linker = 'c')
+        _fcache[outputs] = f
+    return f()
 
-        # optimize and link the cloned env
-        if None is not optimizer:
-            optimizer(env)
 
-        linker = linker_cls(env)
 
-        if keep_locals:# useful flag for debugging!
-            self.__dict__.update(locals())
+# class State:
+#     def __init__(self, init, next = None):
+#         self.init = init
+#         self.next = next
 
-        if profiler is None:
-            self.fn  = linker.make_function(unpack_single=unpack_single)
-        else:
-            self.fn  = linker.make_function(unpack_single=unpack_single,
-                                            profiler=profiler)
-        self.inputs = env.inputs
-        self.outputs = env.outputs
-        self.features = features
-        self.optimizer = optimizer
-        self.linker_cls = linker_cls
-        self.profiler = profiler
-        self.unpack_single = unpack_single
-        self.except_unreachable_input = except_unreachable_input
-        self.keep_locals = keep_locals
-
-    def __call__(self, *args):
-        return self.fn(*args)
-
-
-def eval_outputs(outputs,
-        features = [],
-        optimizer = None,
-        linker_cls = gof.link.PerformLinker,
-        unpack_single = True,
-        keep_locals = True):
-
-    if len(outputs) == 0:
-        #print 'returning with no inputs'
-        if unpack_single:
-            return None
-        else:
-            return []
 
-    inputs = gof.graph.inputs(outputs)
-    if any(not isinstance(input, gof.Constant) for input in inputs):
-        raise TypeError("Cannot evaluate outputs because some of the leaves are not Constant.", outputs)
-    in_data = [i.data for i in inputs]
-    #print 'in_data = ', in_data
-    if len(inputs) != len(in_data):
-        raise Exception('some input data is unknown')
+# class StateFunctionFactory(Function):
 
-    env = gof.env.Env(inputs, outputs)
-    env.replace_all(dict([(i, i.type()) for i in inputs]))
-    env = env.clone(clone_inputs=True)
+#     def __init__(self, inputs, outputs, states, **kwargs):
+#         states_
+        
+#         inputs = [state.init for state in states] + inputs
+#         outputs = [state.next for ]
 
-    _mark_indestructible(env.outputs)
-    if None is not optimizer:
-        optimizer(env)
-    linker = linker_cls(env)
-    fn = linker.make_function(unpack_single=unpack_single)
-    rval = fn(*in_data)
-    return rval
+    
 
 
-def infer_reuse_pattern(env, outputs_to_disown):
-    do_not_reuse = outputs_to_disown
-    seen = set()
-    def walk(r):
-        if env.edge(r) or r in seen:
-            return
-        seen.add(r)
-        do_not_reuse.append(r)
-        op = r.owner
-        dmap = op.destroy_map() if hasattr(op, 'destroy_map') else {}
-        vmap = op.view_map() if hasattr(op, 'view_map') else {}
-        cat = lambda x, y: list(x) + list(y)
-        for r2 in reduce(cat, dmap.values()) + reduce(cat, vmap.values()):
-            accumulate(r2)
-    for output in outputs_to_disown:
-        walk(output)
-    return do_not_reuse
+# class Function:
+#     """
+#     An 'executable' compiled from a graph
+
+#     This class is meant to be used as a function: the idea is to use
+#     __call__(*args) and it will compute your graph's function on the args and
+#     return the value(s) corresponding to the output(s).
+    
+#     @ivar fn: the return value of L{linker.make_function}(False)
+
+#     Additional Attributes if keep_locals == True
+#     inputs - inputs in the env
+#     outputs - outputs in the env
+#     features - features to add to the env
+#     linker_cls - the linker class
+#     linker - the linker allocated from env
+#     env - The env passed to the linker
+
+#     @note: B{Re: Memory ownership, aliasing, re-use:}
+#     That the objects returned by L{Function.__call__}(self, *args) are owned
+#     by self, and that in general these outputs might be overwritten (in-place)
+#     by subsequent calls to L{self.__call__}(*args).  Why?  This behaviour is
+#     necessary for inplace operations to work, and L{Function}'s linker might re-use
+#     memory from one execution to the next in order to make each execution faster.
+
+#     """
+#     def __init__(self, inputs, outputs,
+#             features = [],
+#             optimizer = default_optimizer,
+#             linker_cls = gof.link.PerformLinker,
+#             profiler = None,
+#             unpack_single = True,
+#             except_unreachable_input = True,
+#             keep_locals = True):
+#         """
+#         Copy the graph, optimize, and link it.
+
+#         @param inputs: a list of results to be this function's inputs
+#         @param outputs: a list of results to be this function's outputs
+#         @param features: features to add to the env
+#         @param optimizer: an optimizer to apply to the copied graph, before linking
+#         @param linker_cls: a callable that takes an env and returns a Linker
+#         @param profiler: a L{Profiler} for the produced function (only valid if the
+#                    linker_cls's make_function takes a profiler argument)
+#         @param unpack_single: unpack return value lists of length 1. @see: L{Linker.make_function}
+#         @param keep_locals: add the local variables from __init__ to the class
+#         """
+
+#         _mark_indestructible(outputs)
+
+#         if len(inputs) != len(set(inputs)):
+#             raise Exception('duplicate inputs')
+#         if len(outputs) != len(set(outputs)):
+#             raise Exception('duplicate outputs')
+
+#         #evaluate the orphans, and put these values into the clone of the env
+
+#         orphans = list(gof.graph.results_and_orphans(inputs, outputs,
+#             except_unreachable_input=except_unreachable_input)[1])
+#         orphan_data = eval_outputs(orphans, unpack_single=False)
+
+#         #print 'orphans', orphans
+
+#         #print 'ops', gof.graph.ops(inputs, outputs)
+#         env = gof.env.Env(inputs, outputs)
+
+#         #print 'orphans in env', env.orphans()
+
+#         env, equiv = env.clone_get_equiv(clone_inputs=True)
+#         for feature in features:
+#             env.extend(feature(env))
+#         env.extend(gof.DestroyHandler(env))
+
+#         #print 'orphans after clone', env.orphans()
+
+#         for d, o in zip(orphan_data, [equiv[orphan] for orphan in orphans]):
+#             #print 'assigning orphan value', d
+#             #o.data = d
+#             new_o = gof.Constant(o.type, d)
+#             env.replace(o, new_o)
+#             assert new_o in env.orphans
+
+#         # optimize and link the cloned env
+#         if None is not optimizer:
+#             optimizer(env)
+
+#         linker = linker_cls(env)
+
+#         if keep_locals:# useful flag for debugging!
+#             self.__dict__.update(locals())
+
+#         if profiler is None:
+#             self.fn  = linker.make_function(unpack_single=unpack_single)
+#         else:
+#             self.fn  = linker.make_function(unpack_single=unpack_single,
+#                                             profiler=profiler)
+#         self.inputs = env.inputs
+#         self.outputs = env.outputs
+#         self.features = features
+#         self.optimizer = optimizer
+#         self.linker_cls = linker_cls
+#         self.profiler = profiler
+#         self.unpack_single = unpack_single
+#         self.except_unreachable_input = except_unreachable_input
+#         self.keep_locals = keep_locals
+
+#     def __call__(self, *args):
+#         return self.fn(*args)
+
+
+# def eval_outputs(outputs,
+#         features = [],
+#         optimizer = None,
+#         linker_cls = gof.link.PerformLinker,
+#         unpack_single = True,
+#         keep_locals = True):
+
+#     if len(outputs) == 0:
+#         #print 'returning with no inputs'
+#         if unpack_single:
+#             return None
+#         else:
+#             return []
+
+#     inputs = gof.graph.inputs(outputs)
+#     if any(not isinstance(input, gof.Constant) for input in inputs):
+#         raise TypeError("Cannot evaluate outputs because some of the leaves are not Constant.", outputs)
+#     in_data = [i.data for i in inputs]
+#     #print 'in_data = ', in_data
+#     if len(inputs) != len(in_data):
+#         raise Exception('some input data is unknown')
+
+#     env = gof.env.Env(inputs, outputs)
+#     env.replace_all(dict([(i, i.type()) for i in inputs]))
+#     env = env.clone(clone_inputs=True)
+
+#     _mark_indestructible(env.outputs)
+#     if None is not optimizer:
+#         optimizer(env)
+#     linker = linker_cls(env)
+#     fn = linker.make_function(unpack_single=unpack_single)
+#     rval = fn(*in_data)
+#     return rval
+