Skip to content

Commit a9448bd

Browse files
sbillingegithub-actions[bot]
authored andcommitted
update changelog
1 parent 3a56590 commit a9448bd

19 files changed

+56
-429
lines changed

CHANGELOG.rst

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,60 @@
11
=============
2-
Release notes
2+
Release n
3+
0.2.0
4+
=====
5+
6+
**Added:**
7+
8+
* Coverage report in each PR
9+
* Implement tests for ``compute_objective_function()``
10+
* Add spelling check pre-commit via Codespell
11+
* Added XRD example using real data
12+
* SNMFOptimizer.converged_ attribute to indicate whether the optimization
13+
successfully reached the convergence tolerance (True) or stopped because the
14+
maximum number of iterations was reached (False).
15+
* L-BFGS-B method in scipy for weight optimization in def get_weights
16+
* Support for Python 3.13
17+
* 'SNMFOptimizer.objective_log' attr: dictionary list to track the optimization
18+
process, recording the step, iteration, objective, and timestamp at each update.
19+
Uses the 'step', 'iteration', 'objective' and 'timestamp' keys.
20+
* 'SNMFOptimizer(verbose : Optional[bool])' option and SNMFOptimizer.verbose
21+
attribute to allow users to toggle diagnostic console output.
22+
* Add docformatter config block to the end of the pyproject.toml file.
23+
24+
**Changed:**
25+
26+
* Refactor ``get_objective_function()`` into a static method and getter
27+
* Move project/package naming and related references to the new ``diffpy.stretched-nmf`` name.
28+
* Update to scikit-package 0.3
29+
* Modified all print messages for improved readability and tied them to the new
30+
verbose flag.
31+
* Refactored convergence checks and step-size calculations to pull objective
32+
values directly from objective_log instead of relying on a separate history
33+
array.
34+
35+
**Fixed:**
36+
37+
* Add getting started section and re-arrange install success check instructions
38+
* Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/).
39+
* Remove extraneous files
40+
* Register ``pytest.mark.slow`` in pytest config to avoid unknown-marker warnings.
41+
* Add entry point to the application
42+
* Fix CLI bug due to typo
43+
* Reformat README for PyPi compatibility
44+
* Consistently label variables as private or fit-derived
45+
* Absolute tolerance for updated weighted matrix from 0.5 to 1e-05 in test_subroutines.py
46+
* Include GitHub Issues templates for bug report and feature request
47+
* Conform variable names to PEP-8
48+
49+
**Removed:**
50+
51+
* Old tests and source files from prior, pre-release development.
52+
* cvxpy dependency for linear weight optimization in def get_weights
53+
* Support for Python 3.10
54+
* Removed the 'SNMFOptimizer._objective_history' list, which was made redundant
55+
by the comprehensive 'SNMFOptimizer.objective_log' tracking system.
56+
57+
otes
358
=============
459

560
0.1.3

news/add-convergence-flag.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

news/add-docformatter.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/codecov.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/codespell.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/cvxpy.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

news/declass-obj.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/deprecate.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/doc.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

news/docs-tutorial.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)