Skip to content

Add clearer documentation for valid keys to specify in parameter dictionaries passed to CFL #26

@iwahle

Description

@iwahle

The parameters that can be specified in the dictionaries passed through the block_params list are currently not well documented
in the API reference for CondDensityEstimators, CauseClusterers, or EffectClusterers. The expected keys can be found in the get_default_block_params method in Block class descendants, and in the get_default_model_params method of CDEModel and ClustererModel class descendants, but must be made much easier to access in the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    clusteringdocumentationImprovements or additions to documentationfuture-fixOutstanding issue in code base to be fixed by future developer

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions