Skip to content

Improve math rendering of models in the docs #238

@drbenvincent

Description

@drbenvincent

#232 introduced better docstrings which include mathematical specifications of the models, like this:
Screenshot 2023-09-15 at 21 03 01

In an ideal world we could pimp these maths blocks, e.g.

  • get the equations aligned on the $\sim$ or $=$
  • use greek symbols such as $\beta, \sigma, \mu$ etc
  • get operators to be formatted properly, e.g. \mathrm{Normal}

We could optionally add in the model math for the WeightedProportion model:

class WeightedProportion(LinearModel, RegressorMixin):

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions