Skip to content

correct docstrings for family parameter in Sel_BW #61

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jul 1, 2019
Merged

correct docstrings for family parameter in Sel_BW #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
21bc45f
indent
weikang9009 Jun 29, 2019
621d889
docs for family parameter
weikang9009 Jun 29, 2019
1a8686d
correct typo for parameter "kernel"
weikang9009 Jun 29, 2019
2fb9ff1
(docs) css style
weikang9009 Jun 29, 2019
db2d56f
Merge branch 'css' into docs1
weikang9009 Jun 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/_static/pysal-styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,14 @@

/* Table with a scrollbar */
.bodycontainer { max-height: 600px; width: 100%; margin: 0; overflow-y: auto; }
.table-scrollable { margin: 0; padding: 0; }
.table-scrollable { margin: 0; padding: 0; }

.label {
color: #ff0000;
/*font-size: 100%;*/
}

div.body {
max-width: 1080px;
}

86 changes: 44 additions & 42 deletions mgwr/sel_bw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,17 @@ class Sel_BW(object):
n*k2, local independent variable, including constant.
coords : list of tuples
(x,y) of points used in bandwidth selection
family : string
GWR model type: 'Gaussian', 'logistic, 'Poisson''
offset : array
n*1, the offset variable at the ith location. For Poisson model
this term is often the size of the population at risk or
the expected size of the outcome in spatial epidemiology
Default is None where Ni becomes 1.0 for all locations
kernel : string
kernel function: 'gaussian', 'bisquare', 'exponetial'
family : family object/instance, optional
underlying probability model: Gaussian(), Poisson(),
Binomial(). Default is Gaussian().
offset : array
n*1, the offset variable at the ith location. For Poisson model
this term is often the size of the population at risk or
the expected size of the outcome in spatial epidemiology
Default is None where Ni becomes 1.0 for all locations
kernel : string, optional
kernel function: 'gaussian', 'bisquare', 'exponential'.
Default is 'bisquare'.
fixed : boolean
True for fixed bandwidth and False for adaptive (NN)
multi : True for multiple (covaraite-specific) bandwidths
Expand All @@ -53,9 +55,9 @@ class Sel_BW(object):
constant : boolean
True to include intercept (default) in model and False to exclude
intercept.
spherical : boolean
True for shperical coordinates (long-lat),
False for projected coordinates (defalut).
spherical : boolean
True for shperical coordinates (long-lat),
False for projected coordinates (defalut).

Attributes
----------
Expand Down Expand Up @@ -93,36 +95,36 @@ class Sel_BW(object):
constant : boolean
True to include intercept (default) in model and False to exclude
intercept.
offset : array
n*1, the offset variable at the ith location. For Poisson model
this term is often the size of the population at risk or
the expected size of the outcome in spatial epidemiology
Default is None where Ni becomes 1.0 for all locations
spherical : boolean
True for shperical coordinates (long-lat),
False for projected coordinates (defalut).
search_params : dict
stores search arguments
int_score : boolan
True if adaptive bandwidth is being used and bandwdith
selection should be discrete. False
if fixed bandwidth is being used and bandwidth does not have
to be discrete.
bw : scalar or array-like
Derived optimal bandwidth(s). Will be a scalar for GWR
(multi=False) and a list of scalars for MGWR (multi=True)
with one bandwidth for each covariate.
S : array
n*n, hat matrix derived from the iterative backfitting
algorthim for MGWR during bandwidth selection
R : array
n*n*k, partial hat matrices derived from the iterative
backfitting algoruthm for MGWR during bandwidth selection.
There is one n*n matrix for each of the k covariates.
params : array
n*k, calibrated parameter estimates for MGWR based on the
iterative backfitting algorithm - computed and saved here to
avoid having to do it again in the MGWR object.
offset : array
n*1, the offset variable at the ith location. For Poisson model
this term is often the size of the population at risk or
the expected size of the outcome in spatial epidemiology
Default is None where Ni becomes 1.0 for all locations
spherical : boolean
True for shperical coordinates (long-lat),
False for projected coordinates (defalut).
search_params : dict
stores search arguments
int_score : boolan
True if adaptive bandwidth is being used and bandwdith
selection should be discrete. False
if fixed bandwidth is being used and bandwidth does not have
to be discrete.
bw : scalar or array-like
Derived optimal bandwidth(s). Will be a scalar for GWR
(multi=False) and a list of scalars for MGWR (multi=True)
with one bandwidth for each covariate.
S : array
n*n, hat matrix derived from the iterative backfitting
algorthim for MGWR during bandwidth selection
R : array
n*n*k, partial hat matrices derived from the iterative
backfitting algoruthm for MGWR during bandwidth selection.
There is one n*n matrix for each of the k covariates.
params : array
n*k, calibrated parameter estimates for MGWR based on the
iterative backfitting algorithm - computed and saved here to
avoid having to do it again in the MGWR object.

Examples
--------
Expand Down