--- a +++ b/docs/source/api.rst @@ -0,0 +1,36 @@ +API Guide +============== + +aggmap has two major classes :class:`AggMap` and :class:`AggMapNet`. + +AggMap +---- + +.. autoclass:: aggmap.map.AggMap + :members: + + +AggMapNet +---- + +.. automodule:: aggmap.AggMapNet + :members: + + + +A number of internal functions can also be accessed separately for more fine tuned work. + +Useful Functions +---------------- + +.. automodule:: aggmap.aggmodel.explainer + :members: + +.. automodule:: aggmap.utils.vismap + :members: + +.. automodule:: aggmap.utils.summary + :members: + +.. automodule:: aggmap.utils.gen_nwk + :members: