Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ To activate the virtual environment:
```sh
poetry shell
```
or

```sh
poetry env activate
```

Your prompt will change to indicate you're inside the environment. To exit when you're done:

Expand Down
36 changes: 32 additions & 4 deletions src/geom_nmf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@
from importlib.metadata import version
"""
geom_nmf
========
Geometric NMF: geometric non-negative matrix factorization via maximum-volume simplex fitting.

Public API
----------
GeomNMF Main pipeline.
nfindr N-FINDR endmember extraction (standalone).
log_simplex_volume Log-volume of a simplex spanned by K points.
compute_Phi Source attribution matrix from source means and H.
estimate_weights Recover W from Y and H.
permute_to_reference Permute estimated H, W, Phi to best match a reference ordering.
barplot_Phi Grouped bar plot of Phi (% attribution per source and feature).
"""

from ._base import GeomNMF
from . import _viz as viz
from importlib.metadata import version
from .core import GeomNMF, GeomNMFResult
from .nfindr import nfindr
from .endmembers import log_simplex_volume
from .weights import compute_Phi, estimate_weights
from .utils import permute_to_reference
from .plot import barplot_Phi

__version__ = version("geom-nmf")
__all__ = ["GeomNMF", "viz"]
__all__ = [
"GeomNMF",
"GeomNMFResult",
"nfindr",
"log_simplex_volume",
"compute_Phi",
"estimate_weights",
"permute_to_reference",
"barplot_Phi"
]
65 changes: 0 additions & 65 deletions src/geom_nmf/_base.py

This file was deleted.

77 changes: 0 additions & 77 deletions src/geom_nmf/_viz.py

This file was deleted.

Loading
Loading