Skip to content

Commit

Permalink
DOC: Improve Factor and related docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Sheppard committed May 15, 2020
1 parent dfcc9a8 commit 29beea2
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions statsmodels/multivariate/factor.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ def fit(self, maxiter=50, tol=1e-8, start=None, opt_method='BFGS',
Returns
-------
results: FactorResults
FactorResults
Results class instance.
"""
method = self.method.lower()
if method == 'pa':
Expand Down Expand Up @@ -303,7 +304,8 @@ def loglike(self, par):
Returns
-------
loglike : float
float
The value of the log-likelihood evaluated at par.
"""

if type(par) is np.ndarray:
Expand Down Expand Up @@ -346,7 +348,8 @@ def score(self, par):
Returns
-------
score : ndarray
ndarray
The score function evaluated at par.
"""

if type(par) is np.ndarray:
Expand Down Expand Up @@ -508,7 +511,7 @@ class FactorResults(object):
loadings_no_rot : ndarray
Unrotated loadings, not available under maximum likelihood
analysis.
eigenvalues : ndarray
eigenvals : ndarray
The eigenvalues for a factor analysis obtained using
principal components; not available under ML estimation.
n_comp : int
Expand Down

0 comments on commit 29beea2

Please sign in to comment.