Skip to content

Naming Schemes for Variables and Parameters

David Hägele edited this page Sep 13, 2024 · 8 revisions

This is a list of common variable/parameter names. To keep the API consistent please stick to these suggestions.

  • n
    used for number of something, usually the number of distributions.
    Sometimes we need to be more precise when there are multiple n
    • n_samples - number of samples
    • n_dims - number of dimensions
    • n_rows, n_cols, ...
  • _hi, _lo
    used to indicate high-dimensional and low-dimensional (for dimensionality reduction), e.g. elements_hi
  • distributions, distribs
    used for list of Distribution instances
  • _labels
    used to indicate a list of labels for something, e.g.
    • distrib_labels - list of labels for each distribution
    • dim_labels - list of labels for each dimension (data attribute names)
Clone this wiki locally