docs: clean up and add a real data XRD example#191
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #191 +/- ##
===========================================
- Coverage 77.50% 57.50% -20.00%
===========================================
Files 3 3
Lines 40 40
===========================================
- Hits 31 23 -8
- Misses 9 17 +8
🚀 New features to boost your workflow:
|
sbillinge
left a comment
There was a problem hiding this comment.
This looks great. I am ready to merge. A couple of final cleaning tweaks (see inline).
Also, it may be a feature not a bug, but do we want (a) the dot in the data filenames? Maybe this is ok because it has meaning. (b) the filenames to order alpha-numerically? To do this we want single digits to have leading zeros, so <name>01 , 02 and so on. On balance I would say to leave the dot/point in the names but do the fix to make them sort correctly as this teaches good practice.
| and weights) created by the decomposition. | ||
| objective_difference : float | ||
| n_components_ : int | ||
| Learned number of components from initialization. |
There was a problem hiding this comment.
These should all begin with "The" per group standards.
Please could we also document somewhere where it will show up in the API docs the convention (trailing underscore are attributes that are the result of the refinement)? We don't have to describe about private functions in the docs.
| instability, should be used only after first selecting the best | ||
| value for rho. Suggested adjustment is by powers of 2. | ||
| source_matrix : ndarray of shape (signal_length, n_signals) | ||
| Source data matrix to decompose. |
Closes #128.