Skip to content

Commit

Permalink
Updated documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
frankong committed Jul 14, 2018
1 parent f9ef8b7 commit d9e3938
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/main.rst → doc/core.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Main
====
Core Module
===========

.. toctree::
:maxdepth: 2
Expand Down
3 changes: 2 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ Welcome to sigpy's documentation!
.. toctree::
:maxdepth: 2

main
core
mri
learn
8 changes: 8 additions & 0 deletions doc/learn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Machine Learning
================

.. toctree::
:maxdepth: 2

learn_app
learn_util
7 changes: 7 additions & 0 deletions doc/learn_app.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Machine Learning App
====================

.. _learn_app:

.. automodule:: sigpy.learn.app
:members:
7 changes: 7 additions & 0 deletions doc/learn_util.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Machine Learning Util
=====================

.. _learn_util:

.. automodule:: sigpy.learn.util
:members:
1 change: 0 additions & 1 deletion sigpy/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ class MaxEig(App):
device (Device): Device.
Attributes:
A (Linop)
x (int): Eigenvector with largest eigenvalue.
Output:
Expand Down

0 comments on commit d9e3938

Please sign in to comment.