Skip to content

Commit

Permalink
export model
Browse files Browse the repository at this point in the history
  • Loading branch information
horta committed Apr 17, 2019
1 parent a6a191b commit 681849f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 19 deletions.
40 changes: 22 additions & 18 deletions doc/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,73 +2,77 @@
Model
*****

.. currentmodule:: glimix_core
We also export the underlying inference methods limix uses. Its classes can be accessed
via limix module :mod:`limix.model` or via the package :mod:`glimix_core` itself. Both
ways should work identically.

.. currentmodule:: limix.model

Linear Mixed Models
===================

.. autoclass:: glimix_core.lmm.LMM
.. autoclass:: limix.model.lmm.LMM
:members:

.. autoclass:: glimix_core.lmm.Kron2Sum
.. autoclass:: limix.model.lmm.Kron2Sum
:members:

Generalised Linear Mixed Models
===============================

.. autoclass:: glimix_core.glmm.GLMMNormal
.. autoclass:: limix.model.glmm.GLMMNormal
:members:

.. autoclass:: glimix_core.glmm.GLMMExpFam
.. autoclass:: limix.model.glmm.GLMMExpFam
:members:

Gaussian Process
================

.. autoclass:: glimix_core.gp.GP
.. autoclass:: limix.model.gp.GP
:members:

Generalised Gaussian Process
============================

.. autoclass:: glimix_core.ggp.ExpFamGP
.. autoclass:: limix.model.ggp.ExpFamGP
:members:

Covariance
==========

.. autoclass:: glimix_core.cov.EyeCov
.. autoclass:: limix.model.cov.EyeCov
:members:

.. autoclass:: glimix_core.cov.FreeFormCov
.. autoclass:: limix.model.cov.FreeFormCov
:members:

.. autoclass:: glimix_core.cov.GivenCov
.. autoclass:: limix.model.cov.GivenCov
:members:

.. autoclass:: glimix_core.cov.LinearCov
.. autoclass:: limix.model.cov.LinearCov
:members:

.. autoclass:: glimix_core.cov.SumCov
.. autoclass:: limix.model.cov.SumCov
:members:

.. autoclass:: glimix_core.cov.LRFreeFormCov
.. autoclass:: limix.model.cov.LRFreeFormCov
:members:

.. autoclass:: glimix_core.cov.Kron2SumCov
.. autoclass:: limix.model.cov.Kron2SumCov
:members:

Mean
====

.. autoclass:: glimix_core.mean.OffsetMean
.. autoclass:: limix.model.mean.OffsetMean
:members:

.. autoclass:: glimix_core.mean.LinearMean
.. autoclass:: limix.model.mean.LinearMean
:members:

.. autoclass:: glimix_core.mean.SumMean
.. autoclass:: limix.model.mean.SumMean
:members:

.. autoclass:: glimix_core.mean.KronMean
.. autoclass:: limix.model.mean.KronMean
:members:
3 changes: 2 additions & 1 deletion limix/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from ._example import file_example
from ._testit import test

__version__ = "3.0.dev2"
__version__ = "3.0.dev3"


__all__ = [
Expand All @@ -34,4 +34,5 @@
"test",
"threads",
"vardec",
"model",
]

0 comments on commit 681849f

Please sign in to comment.