Skip to content

GAM parameter names are non-standard #2857

Closed

Description

The trained Generalized Additive Models (aka GAMs) methods for obtaining trained model parameters have non-standard names and various inconsistencies.

These are the properties:

var shapeFunctionsBins = gamModel.GetBinUpperBounds();
var shapeFunctionsValues = gamModel.GetBinEffects();
var numShapeFunctions = gamModel.NumShapeFunctions;
var intercept = gamModel.Intercept;

There are a few issues here:

  1. Nonstandard names
    I propose BinUpperBounds and BinEffects be renamed ShapeFunctionsBins and ShapeFunctionsBinValues.
  2. Inconsistent names
    Sometimes we say ShapeFunctions, sometimes we done. Same solution proposed as No. 1.
  3. Inconsistency in Get methods vs. properties
    e.g. Intercept vs. GetBinUpperBounds.
    I propose we move all the methods to be properties.
    e.g. model.ShapeFunctionsBins.
  4. Names leak implementation
    BinUpperBounds vs. Bins.
    Question: should we just say Bins rather than BinUpperBounds and say that they are the upper bounds for the bin in the documentation? BinUpperBounds is very verbose, and speaks to how we bin.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

APIIssues pertaining the friendly API

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions