Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thvitt committed Jun 20, 2021
1 parent 4cdc7e3 commit 5449670
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 39 deletions.
81 changes: 44 additions & 37 deletions docs/delta.rst
@@ -1,62 +1,69 @@
API documentation
=================
delta package
=============

The end-user facing stuff from the submodules is also exported by the package, so you can call, e.g., ``delta.Corpus``.
Submodules
----------

delta.cluster module
--------------------

.. automodule:: delta.cluster
:members:
:undoc-members:
:show-inheritance:

delta.corpus module
-------------------

Represent, build and manipulate feature matrixes.

.. automodule:: delta.corpus
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

delta.deltas module
-------------------

Normalizations for feature matrixes, distance functions, and distance matrices.

This module contains utilities to create both normalizations (that normalize a feature matrix in some way; cf. :class:`Normalization`) and delta functions (that calculate a distance matrix from a feature matrix).

All normalizations and delta functions created in an application are available from the function registry exposed as variable ``registry``, see :class:`FunctionRegistry` for details on the interface.

The module also provides a standard set of delta functions and normalizations ready to use.

.. automodule:: delta.deltas
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

delta.cluster module
--------------------
delta.experiments module
------------------------

.. automodule:: delta.cluster
:members:
:undoc-members:
:show-inheritance:
.. automodule:: delta.experiments
:members:
:undoc-members:
:show-inheritance:

delta.util module
-----------------------
delta.features module
---------------------

.. automodule:: delta.util
:members:
:undoc-members:
:show-inheritance:
.. automodule:: delta.features
:members:
:undoc-members:
:show-inheritance:

delta.graphics module
---------------------

.. automodule:: delta.graphics
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

delta.util module
-----------------

.. automodule:: delta.util
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: delta
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
4 changes: 2 additions & 2 deletions docs/modules.rst
@@ -1,5 +1,5 @@
Modules
=======
delta
=====

.. toctree::
:maxdepth: 4
Expand Down

0 comments on commit 5449670

Please sign in to comment.