forked from fotisj/pydelta
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
46 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Modules | ||
======= | ||
delta | ||
===== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|