提交 0998da61 authored 作者: James Bergstra's avatar James Bergstra

docs

上级 edc19a40
......@@ -22,9 +22,46 @@ Reference
This is for internal use. User code should use `Param`
.. function:: function(x)
.. function:: function(inputs, outputs, mode=None, updates=[], givens=[],
accept_inplace=False, name=None)
TODO
Return a callable object that will calculate `outputs` from `inputs`.
:type params: list of either Variable or Param instances.
:param params: function parameters, these are not allowed to be shared
variables
:type outputs: list of Variables or Out instances
:param outputs: expressions to compute
:type mode: string or `Mode` instance.
:param mode: compilation mode
:type updates: iterable over pairs (shared_variable, new_expression). List, tuple or dict.
:param updates: update the values for SharedVariable inputs according to these expressions
:type givens: iterable over pairs (Var1, Var2) of Variables.
List, tuple or dict. The Var1
and Var2 in each pair must have the same Type.
:param givens: specific substitutions to make in the
computation graph (Var2 replaces Var1).
:param name: an optional name for this function.
The profile mode will print the time spent in this function.
:rtype: Function instance
:returns: a callable object that will compute the outputs (given the inputs)
and update the implicit function arguments according to the `updates`.
:note: Regarding givens: Be careful to make sure that these substitutions
are independent--behaviour when Var1 of one pair appears in the graph
leading to Var2 in another expression is undefined. Replacements
specified with givens are different from
optimizations in that Var2 is not expected to be equivalent to Var1.
"""
.. _libdoc_compile_function:
......
......@@ -3,14 +3,14 @@
__docformat__ = "restructuredtext en"
import sys, traceback, logging
_logger = logging.getLogger('theano.compile.function_module')
_logger = logging.getLogger('theano.compile.function')
import theano
from io import In
from function_module import orig_function
from pfunc import pfunc
from numpy import any #for to work in python 2.4
def function(inputs, outputs=None, mode=None, updates=[], givens=[], accept_inplace=False, name = None):
def function(inputs, outputs=None, mode=None, updates=[], givens=[], accept_inplace=False, name=None):
"""
Return a callable object that will calculate `outputs` from `inputs`.
......@@ -21,7 +21,7 @@ def function(inputs, outputs=None, mode=None, updates=[], givens=[], accept_inpl
:type outputs: list of Variables or Out instances
:param outputs: expressions to compute
:type mode: string or `theano.compile.Mode` instance.
:type mode: string or `Mode` instance.
:param mode: compilation mode
:type updates: iterable over pairs (shared_variable, new_expression). List, tuple or dict.
......@@ -33,9 +33,9 @@ def function(inputs, outputs=None, mode=None, updates=[], givens=[], accept_inpl
:param givens: specific substitutions to make in the computation graph (Var2 replaces
Var1).
:param name: an optional name for this fct. If used, the profile mode will print the time spent in this fct.
:param name: an optional name for this function. The profile mode will print the time spent in this function.
:rtype: theano.compile.Function
:rtype: Function instance
:returns: a callable object that will compute the outputs (given the inputs)
and update the implicit function arguments according to the `updates`.
......@@ -47,7 +47,7 @@ def function(inputs, outputs=None, mode=None, updates=[], givens=[], accept_inpl
"""
# compute some features of the arguments:
uses_In = any([isinstance(i, theano.In) for i in inputs]) #N.B. the square brackets are ncessary
uses_In = any([isinstance(i, In) for i in inputs]) #N.B. the square brackets are ncessary
uses_tuple = any([isinstance(i, (list, tuple)) for i in inputs])#N.B. the square brackets are ncessary
uses_updates = (updates != [])
uses_givens = (givens != [])
......
"""Provide xscalar, xvector, xmatrix, etc. pseudo-types
"""
import theano.config as config
from theano.scalar import float64, float32
from theano.tensor import (fscalar, fvector, fmatrix, frow, fcol, ftensor3, ftensor4, dscalar,
dvector, dmatrix, drow, dcol, dtensor3, dtensor4)
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论