Skip to content

Commit 90d3ab8

Browse files
yuta-nakaharayuta-nakahara
committed
Minor change
1 parent 23e3ca4 commit 90d3ab8

File tree

8 files changed

+83
-150
lines changed

8 files changed

+83
-150
lines changed

‎bayesml/autoregressive/_autoregressive.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ def set_h_params(self,h_mu_vec=None,h_lambda_mat=None,h_alpha=None,h_beta=None):
8383
h_mu_vec : numpy ndarray, optional
8484
a vector of real numbers, by default None.
8585
h_lambda_mat : numpy ndarray, optional
86-
a positibe definate matrix, by default None.
86+
a positive definate matrix, by default None.
8787
h_alpha : float, optional
8888
a positive real number, by default None.
8989
h_beta : float, optional
90-
a positibe real number, by default None.
90+
a positive real number, by default None.
9191
"""
9292
if h_mu_vec is not None:
9393
_check.float_vec(h_mu_vec,'h_mu_vec',ParameterFormatError)
@@ -270,28 +270,28 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
270270
h0_mu_vec : numpy ndarray, optional
271271
a vector of real numbers, by default [0.0, 0.0, ... , 0.0]
272272
h0_lambda_mat : numpy ndarray, optional
273-
a positibe definate matrix, by default the identity matrix
273+
a positive definate matrix, by default the identity matrix
274274
h0_alpha : float, optional
275275
a positive real number, by default 1.0
276276
h0_beta : float, optional
277-
a positibe real number, by default 1.0
277+
a positive real number, by default 1.0
278278
279279
Attributes
280280
----------
281281
hn_mu_vec : numpy ndarray
282282
a vector of real numbers
283283
hn_lambda_mat : numpy ndarray
284-
a positibe definate matrix
284+
a positive definate matrix
285285
hn_alpha : float
286286
a positive real number
287287
hn_beta : float
288-
a positibe real number
288+
a positive real number
289289
p_m : float
290290
a positive real number
291291
p_lambda : float
292-
a positibe real number
292+
a positive real number
293293
p_nu : float
294-
a positibe real number
294+
a positive real number
295295
"""
296296
def __init__(
297297
self,
@@ -329,7 +329,7 @@ def __init__(
329329
)
330330

331331
def get_constants(self):
332-
"""Get constants of GenModel.
332+
"""Get constants of LearnModel.
333333
334334
Returns
335335
-------
@@ -355,11 +355,11 @@ def set_h0_params(
355355
h0_mu_vec : numpy ndarray, optional
356356
a vector of real numbers, by default None.
357357
h0_lambda_mat : numpy ndarray, optional
358-
a positibe definate matrix, by default None.
358+
a positive definate matrix, by default None.
359359
h0_alpha : float, optional
360360
a positive real number, by default None.
361361
h0_beta : float, optional
362-
a positibe real number, by default None.
362+
a positive real number, by default None.
363363
"""
364364
if h0_mu_vec is not None:
365365
_check.float_vec(h0_mu_vec,'h0_mu_vec',ParameterFormatError)
@@ -430,11 +430,11 @@ def set_hn_params(
430430
hn_mu_vec : numpy ndarray, optional
431431
a vector of real numbers, by default None.
432432
hn_lambda_mat : numpy ndarray, optional
433-
a positibe definate matrix, by default None.
433+
a positive definate matrix, by default None.
434434
hn_alpha : float, optional
435435
a positive real number, by default None.
436436
hn_beta : float, optional
437-
a positibe real number, by default None.
437+
a positive real number, by default None.
438438
"""
439439
if hn_mu_vec is not None:
440440
_check.float_vec(hn_mu_vec,'hn_mu_vec',ParameterFormatError)

‎bayesml/bernoulli/_bernoulli.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class GenModel(base.Generative):
2222
h_alpha : float, optional
2323
a positive real number, by default 0.5.
2424
h_beta : float, optional
25-
a positibe real number, by default 0.5.
25+
a positive real number, by default 0.5.
2626
seed : {None, int}, optional
2727
A seed to initialize numpy.random.default_rng(),
2828
by default None.
@@ -60,7 +60,7 @@ def set_h_params(self,h_alpha=None,h_beta=None):
6060
h_alpha : float, optional
6161
a positive real number, by default None.
6262
h_beta : float, optional
63-
a positibe real number, by default None.
63+
a positive real number, by default None.
6464
"""
6565
if h_alpha is not None:
6666
self.h_alpha = _check.pos_float(h_alpha,'h_alpha',ParameterFormatError)
@@ -197,14 +197,14 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
197197
h0_alpha : float, optional
198198
a positive real number, by default 0.5.
199199
h0_beta : float, optional
200-
a positibe real number, by default 0.5.
200+
a positive real number, by default 0.5.
201201
202202
Attributes
203203
----------
204204
hn_alpha : float
205205
a positive real number
206206
hn_beta : float
207-
a positibe real number
207+
a positive real number
208208
p_theta : float
209209
a real number :math:`\theta_\mathrm{p} \in [0, 1]`
210210
"""
@@ -242,7 +242,7 @@ def set_h0_params(self,h0_alpha=None,h0_beta=None):
242242
h0_alpha : float, optional
243243
a positive real number, by default None.
244244
h0_beta : float, optionanl
245-
a positibe real number, by default None.
245+
a positive real number, by default None.
246246
"""
247247
if h0_alpha is not None:
248248
self.h0_alpha = _check.pos_float(h0_alpha,'h0_alpha',ParameterFormatError)
@@ -270,7 +270,7 @@ def set_hn_params(self,hn_alpha=None,hn_beta=None):
270270
hn_alpha : float, optional
271271
a positive real number, by default None.
272272
hn_beta : float, optional
273-
a positibe real number, by default None.
273+
a positive real number, by default None.
274274
"""
275275
if hn_alpha is not None:
276276
self.hn_alpha = _check.pos_float(hn_alpha,'hn_alpha',ParameterFormatError)

‎bayesml/categorical/_categorical.py

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ def __init__(self,c_degree,theta_vec=None,h_alpha_vec=None,seed=None,):
5151
self.set_params(theta_vec)
5252
self.set_h_params(h_alpha_vec)
5353

54+
def get_constants(self):
55+
"""Get constants of GenModel.
56+
57+
Returns
58+
-------
59+
constants : dict of {str: int}
60+
* ``"c_degree"`` : the value of ``self.c_degree``
61+
"""
62+
return {'c_degree':self.c_degree}
63+
5464
def set_h_params(self,h_alpha_vec=None):
5565
"""Set the hyperparameters of the prior distribution.
5666
@@ -251,6 +261,16 @@ def __init__(self,c_degree,h0_alpha_vec=None):
251261

252262
self.set_h0_params(h0_alpha_vec)
253263

264+
def get_constants(self):
265+
"""Get constants of LearnModel.
266+
267+
Returns
268+
-------
269+
constants : dict of {str: int}
270+
* ``"c_degree"`` : the value of ``self.c_degree``
271+
"""
272+
return {'c_degree':self.c_degree}
273+
254274
def set_h0_params(self,h0_alpha_vec=None):
255275
"""Set the hyperparameters of the prior distribution.
256276
@@ -500,8 +520,9 @@ def pred_and_update(self, x, loss="squared",onehot=True):
500520
501521
Parameters
502522
----------
503-
x : numpy.ndarray
504-
2-dimensional array whose shape is ``(sample_size,c_degree)`` whose rows are one-hot vectors.
523+
x : numpy.ndarray or int
524+
If onehot option is True, 1-dimensional array whose length is ``c_degree``.
525+
If onehot option is False, a non-negative integer.
505526
loss : str, optional
506527
Loss function underlying the Bayes risk function, by default \"squared\".
507528
This function supports \"squared\", \"0-1\", and \"KL\".

‎bayesml/exponential/_exponential.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,18 +196,18 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
196196
h0_alpha : float, optional
197197
a positive real number, by default 1.0.
198198
h0_beta : float, optional
199-
a positibe real number, by default 1.0.
199+
a positive real number, by default 1.0.
200200
201201
Attributes
202202
----------
203203
hn_alpha : float
204204
a positive real number
205205
hn_beta : float
206-
a positibe real number
206+
a positive real number
207207
p_kappa : float
208208
a positive real number
209209
p_lambda : float
210-
a positibe real number
210+
a positive real number
211211
"""
212212
def __init__(self,h0_alpha=1.0, h0_beta=1.0):
213213
# h0_params
@@ -244,7 +244,7 @@ def set_h0_params(self,h0_alpha=None,h0_beta=None):
244244
h0_alpha : float, optional
245245
a positive real number, by default None.
246246
h0_beta : float, optional
247-
a positibe real number, by default None.
247+
a positive real number, by default None.
248248
"""
249249
if h0_alpha is not None:
250250
self.h0_alpha = _check.pos_float(h0_alpha, 'h0_alpha', ParameterFormatError)
@@ -272,7 +272,7 @@ def set_hn_params(self,hn_alpha=None,hn_beta=None):
272272
hn_alpha : float, optional
273273
a positive real number, by default None.
274274
hn_beta : float, optional
275-
a positibe real number, by default None.
275+
a positive real number, by default None.
276276
"""
277277
if hn_alpha is not None:
278278
self.hn_alpha = _check.pos_float(hn_alpha, 'hn_alpha', ParameterFormatError)

‎bayesml/linearregression/_linearregression.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ class GenModel(base.Generative):
2929
h_mu_vec : numpy ndarray, optional
3030
a vector of real numbers, by default [0.0, 0.0, ... , 0.0]
3131
h_lambda_mat : numpy ndarray, optional
32-
a positibe definate matrix, by default the identity matrix
32+
a positive definate matrix, by default the identity matrix
3333
h_alpha : float, optional
3434
a positive real number, by default 1.0
3535
h_beta : float, optional
36-
a positibe real number, by default 1.0
36+
a positive real number, by default 1.0
3737
seed : {None, int}, optional
3838
A seed to initialize numpy.random.default_rng(),
3939
by default None
@@ -83,11 +83,11 @@ def set_h_params(self,h_mu_vec=None,h_lambda_mat=None,h_alpha=None,h_beta=None):
8383
h_mu_vec : numpy ndarray, optional
8484
a vector of real numbers, by default None.
8585
h_lambda_mat : numpy ndarray, optional
86-
a positibe definate matrix, by default None.
86+
a positive definate matrix, by default None.
8787
h_alpha : float, optional
8888
a positive real number, by default None.
8989
h_beta : float, optional
90-
a positibe real number, by default None.
90+
a positive real number, by default None.
9191
"""
9292
if h_mu_vec is not None:
9393
_check.float_vec(h_mu_vec,'h_mu_vec',ParameterFormatError)
@@ -309,28 +309,28 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
309309
h0_mu_vec : numpy ndarray, optional
310310
a vector of real numbers, by default [0.0, 0.0, ... , 0.0]
311311
h0_lambda_mat : numpy ndarray, optional
312-
a positibe definate matrix, by default the identity matrix
312+
a positive definate matrix, by default the identity matrix
313313
h0_alpha : float, optional
314314
a positive real number, by default 1.0
315315
h0_beta : float, optional
316-
a positibe real number, by default 1.0
316+
a positive real number, by default 1.0
317317
318318
Attributes
319319
----------
320320
hn_mu_vec : numpy ndarray
321321
a vector of real numbers
322322
hn_lambda_mat : numpy ndarray
323-
a positibe definate matrix
323+
a positive definate matrix
324324
hn_alpha : float
325325
a positive real number
326326
hn_beta : float
327-
a positibe real number
327+
a positive real number
328328
p_m : float
329329
a positive real number
330330
p_lambda : float
331-
a positibe real number
331+
a positive real number
332332
p_nu : float
333-
a positibe real number
333+
a positive real number
334334
"""
335335
def __init__(
336336
self,
@@ -394,11 +394,11 @@ def set_h0_params(
394394
h0_mu_vec : numpy ndarray, optional
395395
a vector of real numbers, by default None.
396396
h0_lambda_mat : numpy ndarray, optional
397-
a positibe definate matrix, by default None.
397+
a positive definate matrix, by default None.
398398
h0_alpha : float, optional
399399
a positive real number, by default None.
400400
h0_beta : float, optional
401-
a positibe real number, by default None.
401+
a positive real number, by default None.
402402
"""
403403
if h0_mu_vec is not None:
404404
_check.float_vec(h0_mu_vec,'h0_mu_vec',ParameterFormatError)
@@ -456,11 +456,11 @@ def set_hn_params(
456456
hn_mu_vec : numpy ndarray, optional
457457
a vector of real numbers, by default None.
458458
hn_lambda_mat : numpy ndarray, optional
459-
a positibe definate matrix, by default None.
459+
a positive definate matrix, by default None.
460460
hn_alpha : float, optional
461461
a positive real number, by default None.
462462
hn_beta : float, optional
463-
a positibe real number, by default None.
463+
a positive real number, by default None.
464464
"""
465465
if hn_mu_vec is not None:
466466
_check.float_vec(hn_mu_vec,'hn_mu_vec',ParameterFormatError)

0 commit comments

Comments
 (0)