Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation regarding AUTO option for the family parameter of GLM #7991

Closed
exalate-issue-sync bot opened this issue May 11, 2023 · 1 comment
Assignees

Comments

@exalate-issue-sync
Copy link

In PUBDEV-7444 AUTO option for the family parameter of GLM was introduced. This needs to get documented, possibly in the following way:

in https://docs.h2o.ai/h2o/latest-stable/h2o-docs/data-science/gam.html and in https://docs.h2o.ai/h2o/latest-stable/h2o-docs/data-science/glm.html:

in family part, lines to be added:

If the family is AUTO,

  • and the response is Enum with cardinality = 2, then the family is automatically determined as binomial
  • and the response is Enum with cardinality > 2, then the family is automatically determined as multinomial
  • and the response is numeric (Real or Int), then the family is automatically determined as gaussian

in link part, lines to be added:

If the family is AUTO,

  • and link is not specified, then link is determined as default_family (default for the family to which AUTO is determined)
  • and link is specified, then if specified link is compatible with the family to which AUTO is determined, then this link is used. Otherwise, error message is thrown, stating that AUTO for underlying data requires different link + list of possible compatible links.
  • The list of supported links for family = AUTO:

If the response is Enum with cardinality = 2, then Logit is supported

If the response is Enum with cardinality > 2, then only Family_Default is supported (This defaults to multinomial.)

If the response is numeric (Real or Int), then Identity, Log and Inverse are supported.

in https://docs.h2o.ai/h2o/latest-stable/h2o-docs/data-science/algo-params/family.html :

in family part, lines to be added:

AUTO: can fall to three cases based on the response:

  • if the data is Enum with cardinality = 2, then the family is automatically determined as binomial
  • if the data is Enum with cardinality > 2, then the family is automatically determined as multinomial
  • if the data is numeric (Real or Int), then the family is automatically determined as gaussian
@h2o-ops
Copy link
Collaborator

h2o-ops commented May 14, 2023

JIRA Issue Migration Info

Jira Issue: PUBDEV-7648
Assignee: hannah.tillman
Reporter: Zuzana Olajcová
State: Resolved
Fix Version: 3.30.1.1
Attachments: N/A
Development PRs: Available

Linked PRs from JIRA

#4769

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants