Skip to content

Documentation #42

Description

@alecksphillips

Documentation is needed in multiple places.

I've opted to use Sphinx to generate the documentation.
We should use numpy style docstrings: https://numpydoc.readthedocs.io/en/latest/format.html

Any functions that are supposed to be "public-facing" should have full docstrings (and probably doesn't hurt to have documentation for other internal functions).

Places that still need documentation:

  • base.types
  • base.kernel
  • base.random
  • base.util
  • base.algorithms.mcmc
  • base.algorithms.smc
  • base.algorithms.smc_components
  • base.algorithms.decision_forest
  • base.executor
  • domain.additive_structure
  • domain.decision_tree
  • domain.spectrum

Work started on docs branch

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions