[Doc] Fix probabilistic td module doc

[vmoens]

No description provided.

[github-actions]

$\color{#D29922}\textsf{\Large⚠\kern{0.2cm}\normalsize Warning}$ Result of CPU Benchmark Tests

Total Benchmarks: 127. Improved: $\large\color{#35bf28}9$. Worsened: $\large\color{#d91a1a}32$.

Expand to view detailed results

Name	Max	Mean	Ops	Ops on Repo HEAD	Change
test_plain_set_nested	46.5160μs	17.7709μs	56.2718 KOps/s	61.0997 KOps/s	$\textbf{\color{#d91a1a}-7.90\%}$
test_plain_set_stack_nested	43.1800μs	17.6096μs	56.7871 KOps/s	62.4200 KOps/s	$\textbf{\color{#d91a1a}-9.02\%}$
test_plain_set_nested_inplace	63.0170μs	19.6512μs	50.8875 KOps/s	54.1115 KOps/s	$\textbf{\color{#d91a1a}-5.96\%}$
test_plain_set_stack_nested_inplace	62.6350μs	19.7417μs	50.6541 KOps/s	54.6337 KOps/s	$\textbf{\color{#d91a1a}-7.28\%}$
test_items	21.1790μs	2.5101μs	398.3852 KOps/s	380.1421 KOps/s	$\color{#35bf28}+4.80\%$
test_items_nested	1.1701ms	0.2713ms	3.6858 KOps/s	3.4484 KOps/s	$\textbf{\color{#35bf28}+6.88\%}$
test_items_nested_locked	0.4515ms	0.2647ms	3.7775 KOps/s	3.5671 KOps/s	$\textbf{\color{#35bf28}+5.90\%}$
test_items_nested_leaf	0.1518ms	76.7748μs	13.0251 KOps/s	12.8915 KOps/s	$\color{#35bf28}+1.04\%$
test_items_stack_nested	0.5095ms	0.2686ms	3.7231 KOps/s	3.5695 KOps/s	$\color{#35bf28}+4.30\%$
test_items_stack_nested_leaf	0.2342ms	78.7990μs	12.6905 KOps/s	12.5375 KOps/s	$\color{#35bf28}+1.22\%$
test_items_stack_nested_locked	0.5067ms	0.2700ms	3.7036 KOps/s	3.5472 KOps/s	$\color{#35bf28}+4.41\%$
test_keys	23.3230μs	3.9269μs	254.6541 KOps/s	261.4377 KOps/s	$\color{#d91a1a}-2.59\%$
test_keys_nested	0.2538ms	0.1377ms	7.2605 KOps/s	7.2236 KOps/s	$\color{#35bf28}+0.51\%$
test_keys_nested_locked	2.0073ms	0.1429ms	6.9991 KOps/s	6.9860 KOps/s	$\color{#35bf28}+0.19\%$
test_keys_nested_leaf	0.2213ms	0.1179ms	8.4798 KOps/s	8.5750 KOps/s	$\color{#d91a1a}-1.11\%$
test_keys_stack_nested	0.2259ms	0.1368ms	7.3126 KOps/s	7.2266 KOps/s	$\color{#35bf28}+1.19\%$
test_keys_stack_nested_leaf	0.1748ms	0.1160ms	8.6187 KOps/s	8.5549 KOps/s	$\color{#35bf28}+0.75\%$
test_keys_stack_nested_locked	0.2749ms	0.1407ms	7.1067 KOps/s	7.0066 KOps/s	$\color{#35bf28}+1.43\%$
test_values	12.6567μs	1.2014μs	832.3807 KOps/s	863.1342 KOps/s	$\color{#d91a1a}-3.56\%$
test_values_nested	91.5390μs	51.0903μs	19.5732 KOps/s	19.7303 KOps/s	$\color{#d91a1a}-0.80\%$
test_values_nested_locked	93.5350μs	51.0634μs	19.5835 KOps/s	19.7252 KOps/s	$\color{#d91a1a}-0.72\%$
test_values_nested_leaf	93.6130μs	46.0832μs	21.6999 KOps/s	21.7585 KOps/s	$\color{#d91a1a}-0.27\%$
test_values_stack_nested	95.9970μs	52.0192μs	19.2237 KOps/s	19.3678 KOps/s	$\color{#d91a1a}-0.74\%$
test_values_stack_nested_leaf	84.8570μs	45.3571μs	22.0473 KOps/s	21.5835 KOps/s	$\color{#35bf28}+2.15\%$
test_values_stack_nested_locked	95.8270μs	51.5576μs	19.3958 KOps/s	19.5179 KOps/s	$\color{#d91a1a}-0.63\%$
test_membership	22.7730μs	1.3816μs	723.8094 KOps/s	745.3751 KOps/s	$\color{#d91a1a}-2.89\%$
test_membership_nested	0.1373ms	3.4628μs	288.7840 KOps/s	287.9387 KOps/s	$\color{#35bf28}+0.29\%$
test_membership_nested_leaf	0.1554ms	3.6013μs	277.6749 KOps/s	285.7958 KOps/s	$\color{#d91a1a}-2.84\%$
test_membership_stacked_nested	18.1340μs	3.4558μs	289.3727 KOps/s	272.2254 KOps/s	$\textbf{\color{#35bf28}+6.30\%}$
test_membership_stacked_nested_leaf	30.6360μs	3.4931μs	286.2785 KOps/s	285.0782 KOps/s	$\color{#35bf28}+0.42\%$
test_membership_nested_last	30.1060μs	4.2415μs	235.7648 KOps/s	235.8399 KOps/s	$\color{#d91a1a}-0.03\%$
test_membership_nested_leaf_last	29.1940μs	4.2479μs	235.4131 KOps/s	233.3203 KOps/s	$\color{#35bf28}+0.90\%$
test_membership_stacked_nested_last	30.0650μs	8.7194μs	114.6865 KOps/s	208.1493 KOps/s	$\textbf{\color{#d91a1a}-44.90\%}$
test_membership_stacked_nested_leaf_last	37.1080μs	8.7817μs	113.8726 KOps/s	206.2657 KOps/s	$\textbf{\color{#d91a1a}-44.79\%}$
test_nested_getleaf	51.2730μs	10.6030μs	94.3132 KOps/s	93.0213 KOps/s	$\color{#35bf28}+1.39\%$
test_nested_get	0.1460ms	10.1462μs	98.5591 KOps/s	98.4806 KOps/s	$\color{#35bf28}+0.08\%$
test_stacked_getleaf	43.9710μs	10.5420μs	94.8583 KOps/s	94.1801 KOps/s	$\color{#35bf28}+0.72\%$
test_stacked_get	41.9580μs	9.8384μs	101.6425 KOps/s	98.4698 KOps/s	$\color{#35bf28}+3.22\%$
test_nested_getitemleaf	49.9820μs	11.1630μs	89.5820 KOps/s	83.7572 KOps/s	$\textbf{\color{#35bf28}+6.95\%}$
test_nested_getitem	49.9320μs	10.2517μs	97.5453 KOps/s	97.2080 KOps/s	$\color{#35bf28}+0.35\%$
test_stacked_getitemleaf	52.2470μs	11.1544μs	89.6504 KOps/s	83.3522 KOps/s	$\textbf{\color{#35bf28}+7.56\%}$
test_stacked_getitem	38.7210μs	10.1545μs	98.4784 KOps/s	91.9720 KOps/s	$\textbf{\color{#35bf28}+7.07\%}$
test_lock_nested	55.9757ms	0.4227ms	2.3657 KOps/s	2.8594 KOps/s	$\textbf{\color{#d91a1a}-17.27\%}$
test_lock_stack_nested	1.0078ms	0.3165ms	3.1592 KOps/s	3.2056 KOps/s	$\color{#d91a1a}-1.45\%$
test_unlock_nested	1.5485ms	0.3762ms	2.6579 KOps/s	2.5511 KOps/s	$\color{#35bf28}+4.19\%$
test_unlock_stack_nested	1.6336ms	0.3225ms	3.1010 KOps/s	3.1375 KOps/s	$\color{#d91a1a}-1.16\%$
test_flatten_speed	0.2458ms	96.0103μs	10.4155 KOps/s	10.4550 KOps/s	$\color{#d91a1a}-0.38\%$
test_unflatten_speed	0.5313ms	0.4134ms	2.4187 KOps/s	2.4491 KOps/s	$\color{#d91a1a}-1.24\%$
test_common_ops	3.4113ms	0.7683ms	1.3016 KOps/s	1.4504 KOps/s	$\textbf{\color{#d91a1a}-10.26\%}$
test_creation	28.9130μs	1.9108μs	523.3311 KOps/s	527.5455 KOps/s	$\color{#d91a1a}-0.80\%$
test_creation_empty	51.6950μs	11.9553μs	83.6446 KOps/s	112.9520 KOps/s	$\textbf{\color{#d91a1a}-25.95\%}$
test_creation_nested_1	41.3570μs	14.5811μs	68.5821 KOps/s	85.9416 KOps/s	$\textbf{\color{#d91a1a}-20.20\%}$
test_creation_nested_2	0.1448ms	18.1381μs	55.1326 KOps/s	66.5710 KOps/s	$\textbf{\color{#d91a1a}-17.18\%}$
test_clone	0.1450ms	13.6617μs	73.1976 KOps/s	73.8375 KOps/s	$\color{#d91a1a}-0.87\%$
test_getitem[int]	48.9010μs	11.6208μs	86.0527 KOps/s	84.3388 KOps/s	$\color{#35bf28}+2.03\%$
test_getitem[slice_int]	3.6928ms	23.5313μs	42.4965 KOps/s	42.6475 KOps/s	$\color{#d91a1a}-0.35\%$
test_getitem[range]	80.0180μs	58.0212μs	17.2351 KOps/s	16.7043 KOps/s	$\color{#35bf28}+3.18\%$
test_getitem[tuple]	81.4510μs	19.1523μs	52.2131 KOps/s	52.2541 KOps/s	$\color{#d91a1a}-0.08\%$
test_getitem[list]	0.1903ms	42.4109μs	23.5789 KOps/s	24.2694 KOps/s	$\color{#d91a1a}-2.85\%$
test_setitem_dim[int]	68.7470μs	37.0056μs	27.0229 KOps/s	29.8365 KOps/s	$\textbf{\color{#d91a1a}-9.43\%}$
test_setitem_dim[slice_int]	0.2191ms	66.0079μs	15.1497 KOps/s	16.2206 KOps/s	$\textbf{\color{#d91a1a}-6.60\%}$
test_setitem_dim[range]	0.1748ms	87.4941μs	11.4293 KOps/s	12.0892 KOps/s	$\textbf{\color{#d91a1a}-5.46\%}$
test_setitem_dim[tuple]	0.1007ms	52.2476μs	19.1396 KOps/s	20.3954 KOps/s	$\textbf{\color{#d91a1a}-6.16\%}$
test_setitem	92.0500μs	21.5164μs	46.4761 KOps/s	50.6621 KOps/s	$\textbf{\color{#d91a1a}-8.26\%}$
test_set	83.9050μs	20.8345μs	47.9973 KOps/s	51.8110 KOps/s	$\textbf{\color{#d91a1a}-7.36\%}$
test_set_shared	2.0502ms	0.1443ms	6.9306 KOps/s	7.1984 KOps/s	$\color{#d91a1a}-3.72\%$
test_update	0.1605ms	23.6450μs	42.2922 KOps/s	49.4144 KOps/s	$\textbf{\color{#d91a1a}-14.41\%}$
test_update_nested	0.1277ms	32.3635μs	30.8990 KOps/s	34.6821 KOps/s	$\textbf{\color{#d91a1a}-10.91\%}$
test_update__nested	76.8430μs	25.2323μs	39.6317 KOps/s	40.0437 KOps/s	$\color{#d91a1a}-1.03\%$
test_set_nested	84.1970μs	22.6542μs	44.1419 KOps/s	47.1005 KOps/s	$\textbf{\color{#d91a1a}-6.28\%}$
test_set_nested_new	0.1006ms	27.2964μs	36.6348 KOps/s	39.7477 KOps/s	$\textbf{\color{#d91a1a}-7.83\%}$
test_select	0.1242ms	42.5152μs	23.5210 KOps/s	23.9536 KOps/s	$\color{#d91a1a}-1.81\%$
test_select_nested	0.1315ms	61.3483μs	16.3004 KOps/s	16.6048 KOps/s	$\color{#d91a1a}-1.83\%$
test_exclude_nested	0.2282ms	0.1207ms	8.2818 KOps/s	8.2238 KOps/s	$\color{#35bf28}+0.70\%$
test_empty[True]	0.4893ms	0.4023ms	2.4859 KOps/s	2.5202 KOps/s	$\color{#d91a1a}-1.36\%$
test_empty[False]	6.0952μs	1.0975μs	911.1552 KOps/s	904.4173 KOps/s	$\color{#35bf28}+0.74\%$
test_unbind_speed	0.5109ms	0.2660ms	3.7590 KOps/s	3.8733 KOps/s	$\color{#d91a1a}-2.95\%$
test_unbind_speed_stack0	0.4494ms	0.2531ms	3.9507 KOps/s	3.9388 KOps/s	$\color{#35bf28}+0.30\%$
test_unbind_speed_stack1	75.9934ms	0.7430ms	1.3460 KOps/s	1.2994 KOps/s	$\color{#35bf28}+3.59\%$
test_split	79.9759ms	1.6325ms	612.5522 Ops/s	621.3612 Ops/s	$\color{#d91a1a}-1.42\%$
test_chunk	78.6192ms	1.6254ms	615.2352 Ops/s	618.1850 Ops/s	$\color{#d91a1a}-0.48\%$
test_creation[device0]	0.3490ms	0.1054ms	9.4860 KOps/s	9.6776 KOps/s	$\color{#d91a1a}-1.98\%$
test_creation_from_tensor	3.3163ms	83.8660μs	11.9238 KOps/s	11.9355 KOps/s	$\color{#d91a1a}-0.10\%$
test_add_one[memmap_tensor0]	0.1871ms	5.6801μs	176.0544 KOps/s	190.3233 KOps/s	$\textbf{\color{#d91a1a}-7.50\%}$
test_contiguous[memmap_tensor0]	10.3190μs	0.6334μs	1.5788 MOps/s	1.5407 MOps/s	$\color{#35bf28}+2.47\%$
test_stack[memmap_tensor0]	58.9190μs	3.5879μs	278.7134 KOps/s	270.8830 KOps/s	$\color{#35bf28}+2.89\%$
test_memmaptd_index	1.0818ms	0.2382ms	4.1977 KOps/s	4.1732 KOps/s	$\color{#35bf28}+0.59\%$
test_memmaptd_index_astensor	0.6718ms	0.3126ms	3.1990 KOps/s	3.2121 KOps/s	$\color{#d91a1a}-0.41\%$
test_memmaptd_index_op	1.5067ms	0.6308ms	1.5852 KOps/s	1.7718 KOps/s	$\textbf{\color{#d91a1a}-10.53\%}$
test_serialize_model	0.1128s	0.1048s	9.5385 Ops/s	9.0373 Ops/s	$\textbf{\color{#35bf28}+5.55\%}$
test_serialize_model_pickle	0.4459s	0.3773s	2.6503 Ops/s	2.6386 Ops/s	$\color{#35bf28}+0.44\%$
test_serialize_weights	0.1929s	0.1168s	8.5600 Ops/s	9.3367 Ops/s	$\textbf{\color{#d91a1a}-8.32\%}$
test_serialize_weights_returnearly	0.1954s	0.1343s	7.4477 Ops/s	8.1941 Ops/s	$\textbf{\color{#d91a1a}-9.11\%}$
test_serialize_weights_pickle	0.9033s	0.5765s	1.7345 Ops/s	2.3596 Ops/s	$\textbf{\color{#d91a1a}-26.49\%}$
test_serialize_weights_filesystem	0.1790s	0.1020s	9.8019 Ops/s	9.7783 Ops/s	$\color{#35bf28}+0.24\%$
test_serialize_model_filesystem	0.1027s	94.3941ms	10.5939 Ops/s	9.7025 Ops/s	$\textbf{\color{#35bf28}+9.19\%}$
test_reshape_pytree	57.7880μs	25.1402μs	39.7770 KOps/s	39.0513 KOps/s	$\color{#35bf28}+1.86\%$
test_reshape_td	79.0760μs	33.4954μs	29.8548 KOps/s	30.0978 KOps/s	$\color{#d91a1a}-0.81\%$
test_view_pytree	75.3470μs	25.1890μs	39.6999 KOps/s	39.4445 KOps/s	$\color{#35bf28}+0.65\%$
test_view_td	0.1021ms	37.9487μs	26.3514 KOps/s	26.4723 KOps/s	$\color{#d91a1a}-0.46\%$
test_unbind_pytree	69.7900μs	29.3042μs	34.1248 KOps/s	34.1679 KOps/s	$\color{#d91a1a}-0.13\%$
test_unbind_td	0.3779ms	38.4812μs	25.9867 KOps/s	26.0603 KOps/s	$\color{#d91a1a}-0.28\%$
test_split_pytree	68.9780μs	28.9048μs	34.5963 KOps/s	33.8361 KOps/s	$\color{#35bf28}+2.25\%$
test_split_td	0.5163ms	40.9865μs	24.3983 KOps/s	24.3354 KOps/s	$\color{#35bf28}+0.26\%$
test_add_pytree	0.1266ms	35.0432μs	28.5362 KOps/s	28.6519 KOps/s	$\color{#d91a1a}-0.40\%$
test_add_td	0.1327ms	57.4247μs	17.4141 KOps/s	17.6788 KOps/s	$\color{#d91a1a}-1.50\%$
test_distributed	0.2624ms	99.6375μs	10.0364 KOps/s	9.8679 KOps/s	$\color{#35bf28}+1.71\%$
test_tdmodule	65.0700μs	19.1730μs	52.1566 KOps/s	60.7438 KOps/s	$\textbf{\color{#d91a1a}-14.14\%}$
test_tdmodule_dispatch	77.0020μs	37.5461μs	26.6339 KOps/s	30.2996 KOps/s	$\textbf{\color{#d91a1a}-12.10\%}$
test_tdseq	44.5630μs	22.2067μs	45.0314 KOps/s	51.1019 KOps/s	$\textbf{\color{#d91a1a}-11.88\%}$
test_tdseq_dispatch	69.0580μs	43.1388μs	23.1810 KOps/s	26.3282 KOps/s	$\textbf{\color{#d91a1a}-11.95\%}$
test_instantiation_functorch	1.8122ms	1.2960ms	771.6157 Ops/s	760.9856 Ops/s	$\color{#35bf28}+1.40\%$
test_instantiation_td	66.9233ms	1.0966ms	911.9328 Ops/s	987.7600 Ops/s	$\textbf{\color{#d91a1a}-7.68\%}$
test_exec_functorch	0.3202ms	0.1608ms	6.2171 KOps/s	5.5160 KOps/s	$\textbf{\color{#35bf28}+12.71\%}$
test_exec_functional_call	0.2990ms	0.1478ms	6.7664 KOps/s	6.6925 KOps/s	$\color{#35bf28}+1.10\%$
test_exec_td	0.2332ms	0.1456ms	6.8667 KOps/s	6.8862 KOps/s	$\color{#d91a1a}-0.28\%$
test_exec_td_decorator	1.1709ms	0.2224ms	4.4971 KOps/s	4.5110 KOps/s	$\color{#d91a1a}-0.31\%$
test_vmap_mlp_speed[True-True]	0.6959ms	0.4943ms	2.0231 KOps/s	2.1064 KOps/s	$\color{#d91a1a}-3.96\%$
test_vmap_mlp_speed[True-False]	1.8042ms	0.5136ms	1.9470 KOps/s	2.1084 KOps/s	$\textbf{\color{#d91a1a}-7.65\%}$
test_vmap_mlp_speed[False-True]	0.6347ms	0.3978ms	2.5140 KOps/s	2.5487 KOps/s	$\color{#d91a1a}-1.36\%$
test_vmap_mlp_speed[False-False]	0.6618ms	0.3969ms	2.5192 KOps/s	2.5894 KOps/s	$\color{#d91a1a}-2.71\%$
test_vmap_mlp_speed_decorator[True-True]	1.3277ms	0.5573ms	1.7942 KOps/s	1.8339 KOps/s	$\color{#d91a1a}-2.16\%$
test_vmap_mlp_speed_decorator[True-False]	0.8056ms	0.5606ms	1.7839 KOps/s	1.8390 KOps/s	$\color{#d91a1a}-3.00\%$
test_vmap_mlp_speed_decorator[False-True]	0.7270ms	0.4672ms	2.1403 KOps/s	2.2355 KOps/s	$\color{#d91a1a}-4.26\%$
test_vmap_mlp_speed_decorator[False-False]	1.1365ms	0.4611ms	2.1688 KOps/s	2.2372 KOps/s	$\color{#d91a1a}-3.06\%$
test_to_module_speed[True]	2.8080ms	1.6707ms	598.5474 Ops/s	592.0545 Ops/s	$\color{#35bf28}+1.10\%$
test_to_module_speed[False]	2.5246ms	1.6434ms	608.4986 Ops/s	608.7017 Ops/s	$\color{#d91a1a}-0.03\%$