Skip to content

Commit a0e452f

Browse files
authored
Add public API skeletons and export ml module (#1081)
* Add public API skeletons and export ml module * Make modifications according to new specs, add shared assertions and internel helper placeholders * Add tests for private functions * Modify data types and function usage
1 parent 347f141 commit a0e452f

4 files changed

Lines changed: 544 additions & 30 deletions

File tree

docs/api.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,27 @@ all NiMARE workflows.
242242
transforms.z_to_t
243243
transforms.z_to_p
244244

245+
.. _api_ml_ref:
246+
247+
:mod:`nimare.ml`: Machine-learning helpers
248+
-----------------------------------------------------
249+
250+
.. automodule:: nimare.ml
251+
:no-members:
252+
:no-inherited-members:
253+
254+
.. currentmodule:: nimare
255+
256+
.. autosummary::
257+
:toctree: generated/
258+
:template: class.rst
259+
260+
ml.MAFeatureDataset
261+
ml.MAFeatureExtractor
262+
:template: function.rst
263+
264+
ml.make_map_reducer
265+
245266

246267
.. _api_extract_ref:
247268

nimare/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
decode,
1818
io,
1919
meta,
20+
ml,
2021
reports,
2122
resources,
2223
stats,
@@ -29,6 +30,7 @@
2930
__all__ = [
3031
"base",
3132
"dataset",
33+
"ml",
3234
"meta",
3335
"correct",
3436
"annotate",

0 commit comments

Comments
 (0)