提交 bf369d76 authored 作者: Thomas George's avatar Thomas George

added documentation for solve. I had to add it to doc/.../slinalg.txt as well…

added documentation for solve. I had to add it to doc/.../slinalg.txt as well otherwise the method signature looked ugly in sphinx
上级 ca8cb2c2
...@@ -20,3 +20,8 @@ API ...@@ -20,3 +20,8 @@ API
.. automodule:: theano.tensor.slinalg .. automodule:: theano.tensor.slinalg
:members: :members:
:exclude-members: solve, solve_lower_triangular, solve_upper_triangular
.. autofunction:: solve(a, b)
.. autofunction:: solve_lower_triangular(a, b)
.. autofunction:: solve_upper_triangular(a, b)
...@@ -263,10 +263,31 @@ class Solve(Op): ...@@ -263,10 +263,31 @@ class Solve(Op):
A_bar = tensor.triu(A_bar) A_bar = tensor.triu(A_bar)
return [A_bar, b_bar] return [A_bar, b_bar]
solve = Solve() # general solve solve = Solve()
"""
Solves the equation ``a x = b`` for x, where ``a`` is a matrix and
``b`` can be either a vector or a matrix.
Note
Parameters
----------
a : (M, M) symbolix matrix
A square matrix
b : (M,) or (M, N) symbolic vector or matrix
Right hand side matrix in ``a x = b``
Returns
-------
x : (M, ) or (M, N) symbolic vector or matrix
x will have the same shape as b
"""
# lower and upper triangular solves # lower and upper triangular solves
solve_lower_triangular = Solve(A_structure='lower_triangular', lower=True) solve_lower_triangular = Solve(A_structure='lower_triangular', lower=True)
"""Optimized implementation of :func:`theano.tensor.slinalg.solve` when A is lower triangular."""
solve_upper_triangular = Solve(A_structure='upper_triangular', lower=False) solve_upper_triangular = Solve(A_structure='upper_triangular', lower=False)
"""Optimized implementation of :func:`theano.tensor.slinalg.solve` when A is upper triangular."""
# TODO: Optimizations to replace multiplication by matrix inverse # TODO: Optimizations to replace multiplication by matrix inverse
# with solve() Op (still unwritten) # with solve() Op (still unwritten)
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论