Complete description for index.rst in doc

diffpy / diffpy.snmf

Other

1 stars 5 forks source link

Complete description for index.rst in doc #69

Open bobleesj opened 2 months ago

bobleesj commented 2 months ago

It appears that the documentation is incomplete:

Welcome to SNMF's Documentation!
====================================

``SNMF``: This library implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF
(ssNMF) algorithms described in ...

sbillinge commented 2 months ago

yes, this package itself is incomplete. I am not sure it is even working. under development.

Finishing it is not part of the summer project, so please just make an issue when you find something that needs fixing but move on. This is an important package so we will have another project ahead to finish it.