Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 1.56 KB

api.rst

File metadata and controls

76 lines (53 loc) · 1.56 KB

srlearn API

.. currentmodule:: srlearn

Core Classes

These classes form the set of core pieces for describing the data, providing background knowledge, and learning.

.. autosummary::
   :toctree: generated/
   :template: class.rst

   Database
   Background
   rdn.BoostedRDNClassifier
   rdn.BoostedRDNRegressor

Data Sets

There are some toy datasets built into the srlearn package. For more datasets, see the relational-datasets package.

.. autosummary::
   :toctree: generated/
   :template: function.rst

   datasets.load_toy_cancer
   datasets.load_toy_father

Plotting and Visualization

These may be helpful for visualizing trees.

.. autosummary::
   :toctree: generated/
   :template: function.rst

   plotting.export_digraph
   plotting.plot_digraph

Utilities

Some of these are for behind-the-scenes operations, but tend to be useful for further development (contributions are welcome!).

.. autosummary::
   :toctree: generated/
   :template: class.rst

   base.BaseBoostedRelationalModel
   system_manager.FileSystem

.. autosummary::
   :toctree: generated/
   :template: function.rst

   system_manager.reset

Deprecated boostsrl objects

This is the old API style that has been deprecated. It is no longer tested or actively developed and is pending removal in 0.6.0.

.. autosummary::
   :toctree: generated/

   srlearn.boostsrl