a4ad6460a2
Format return docstrings and add typing ( #437 )
...
* typing and return docstrings
* address typing complaints
* allow redefinition
* typing complains for pandas
* .values -> to_numpy()
2022-09-15 11:46:14 +00:00
c0fe76c098
Changed all docstring instances of np.array to np.ndarray ( #336 )
...
* Changed all instances of np.array in docstring to np.ndarray
* np.array is NOT a proper class name it is just a function to
create np.ndarrays and therefore should not be parameter class
* Black formatting compliance
2022-08-08 23:30:12 -07:00
af11106e77
Clarify labels format ( #282 )
...
Add clarification of the labels format requirements for all major API functions.
* Fix broken link
* Clarify reqs for labels format. rank.py does not yet support multi_label
* add double ticks to code in docstrings
* clarify docstring
* further clarify multi_label vs single label labels reqs
* also add new docstring to confident joint
2022-06-20 12:58:24 -07:00
1f1d02435d
overlapping_desc ( #277 )
2022-06-14 11:29:39 -07:00
7d498a8c39
black formatting ( #273 )
2022-06-10 10:43:27 -07:00
d7e9e4b073
docstring clarifications ( #270 )
2022-06-10 10:36:23 -07:00
966acf8a61
final tutorial edits. dataset docstrings imp ( #217 )
...
* final tutorial edits. dataset docstrings imp
* add back instructions for user installation
* remove useless pycharm metadata.
* remove extraneous comma
2022-04-15 23:00:17 -04:00
ee6494de4d
Small clarification in docstring
2022-04-15 20:54:34 -04:00
e971350795
Clarify and fix several docstrings. ( #214 )
...
* Clarify and fix several docstrings.
* Adjustments based on Jonas's comments.
* fix typo
2022-04-15 19:06:45 -04:00
fac6c112aa
health_summary bug fixes + notebook support ( #212 )
...
* bug fixes and jupyter notebook support added
* Increase test coverage.
* Fix bug. will always try to display if possible.
2022-04-15 14:54:00 -04:00
b305b417ad
Make minor doc tweaks
2022-04-13 20:28:21 -04:00
9cdf5050f5
Clarify joint asymmetry in docs. reset indices in dfs
2022-04-12 23:46:23 -04:00
2597e3e81e
Make key match function name
...
This makes it consistent with the other two,
"classes_by_label_quality" and "overlapping_classes".
2022-04-12 09:23:43 -04:00
374f6e053a
Fix typo
2022-04-12 09:21:29 -04:00
8470c72667
Checkpoint addressing Jonas's feedback
...
Co-Authored-By: Curtis G. Northcutt <curtis.northcutt@gmail.com >
2022-04-11 17:45:33 -04:00
dc6fa956cb
Make a pass over docs
2022-04-11 13:15:43 -04:00
0fb2439713
Totally rewritten. class methods merged. now uses pandas. health summary.
2022-04-10 14:37:55 +00:00
06b990b5f1
Skeleton commit for first version of new dataset module. UNTESTED
2022-04-06 22:26:29 -04:00
Jonas Mueller