-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Closed
Labels
APIIssues pertaining the friendly APIIssues pertaining the friendly API
Milestone
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:
- Nonstandard names
I proposeBinUpperBounds
andBinEffects
be renamedShapeFunctionsBins
andShapeFunctionsBinValues
. - Inconsistent names
Sometimes we sayShapeFunctions
, sometimes we done. Same solution proposed as No. 1. - 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
. - Names leak implementation
BinUpperBounds
vs.Bins
.
Question: should we just sayBins
rather thanBinUpperBounds
and say that they are the upper bounds for the bin in the documentation?BinUpperBounds
is very verbose, and speaks to how we bin.
Metadata
Metadata
Assignees
Labels
APIIssues pertaining the friendly APIIssues pertaining the friendly API