@@ -50,6 +50,7 @@ class Codebook:
50
50
----------
51
51
codebook: core.Codebook
52
52
A reference to the underlying rust data structure
53
+
53
54
"""
54
55
55
56
codebook : _lc .Codebook
@@ -89,6 +90,7 @@ def from_df(
89
90
no_hypers: bool, optional
90
91
If `True`, disable hyper prior inference. Priors will be derived
91
92
from the data and will remain static.
93
+
92
94
"""
93
95
94
96
if isinstance (df , pd .DataFrame ):
@@ -214,6 +216,7 @@ def column_metadata(self) -> _ColumnMetadataIndexer:
214
216
}
215
217
>>> codebook.column_names[-5:]
216
218
['solitary', 'nestspot', 'domestic', 'number-in-wild', 'scary']
219
+
217
220
"""
218
221
return _ColumnMetadataIndexer (self .codebook )
219
222
@@ -228,6 +231,7 @@ def shape(self) -> Tuple[int, int]:
228
231
>>> codebook = Animals().codebook
229
232
>>> codebook.shape
230
233
(50, 85)
234
+
231
235
"""
232
236
return self .codebook .shape
233
237
@@ -242,6 +246,7 @@ def row_names(self) -> List[str]:
242
246
>>> codebook = Animals().codebook
243
247
>>> codebook.row_names[:4]
244
248
['antelope', 'grizzly+bear', 'killer+whale', 'beaver']
249
+
245
250
"""
246
251
return self .codebook .row_names
247
252
@@ -256,6 +261,7 @@ def column_names(self) -> List[str]:
256
261
>>> codebook = Animals().codebook
257
262
>>> codebook.column_names[:4]
258
263
['black', 'white', 'blue', 'brown']
264
+
259
265
"""
260
266
return self .codebook .column_names
261
267
@@ -284,6 +290,7 @@ def rename(self, name: str):
284
290
view_alpha_prior: G(α: 1, β: 1)
285
291
columns: 85
286
292
rows: 50
293
+
287
294
"""
288
295
codebook = copy .copy (self )
289
296
codebook .codebook .rename (name )
@@ -318,6 +325,7 @@ def set_state_alpha_prior(self, shape: float = 1.0, rate: float = 1.0):
318
325
view_alpha_prior: G(α: 1, β: 1)
319
326
columns: 85
320
327
rows: 50
328
+
321
329
"""
322
330
codebook = copy .copy (self )
323
331
codebook .codebook .set_state_alpha_prior (shape , rate )
@@ -352,6 +360,7 @@ def set_view_alpha_prior(self, shape: float = 1.0, rate: float = 1.0):
352
360
view_alpha_prior: G(α: 2, β: 3.1)
353
361
columns: 85
354
362
rows: 50
363
+
355
364
"""
356
365
codebook = copy .copy (self )
357
366
codebook .codebook .set_view_alpha_prior (shape , rate )
@@ -392,6 +401,7 @@ def set_row_names(
392
401
>>> new_rows = np.array(["one", "two", "three-hahaha"])
393
402
>>> codebook.set_row_names(new_rows).row_names
394
403
['one', 'two', 'three-hahaha']
404
+
395
405
"""
396
406
if isinstance (row_names , (pl .Series , pd .Series )):
397
407
row_names = row_names .to_list ()
@@ -433,6 +443,7 @@ def value_map(self, col: str):
433
443
ValueMap (UInt, k=2)
434
444
>>> [c for c in vm.values()]
435
445
[0, 1]
446
+
436
447
"""
437
448
return self .column_metadata [col ].value_map
438
449
0 commit comments