[Doc] Installation instructions in API ref

[vmoens]

No description provided.

[github-actions]

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

Total Benchmarks: 124. Improved: $\large\color{#35bf28}6$. Worsened: $\large\color{#d91a1a}11$.

Expand to view detailed results

Name	Max	Mean	Ops	Ops on Repo HEAD	Change
test_plain_set_nested	37.0590μs	17.3441μs	57.6566 KOps/s	59.8410 KOps/s	$\color{#d91a1a}-3.65\%$
test_plain_set_stack_nested	0.1708ms	0.1443ms	6.9321 KOps/s	6.8745 KOps/s	$\color{#35bf28}+0.84\%$
test_plain_set_nested_inplace	53.3890μs	19.9567μs	50.1086 KOps/s	51.3203 KOps/s	$\color{#d91a1a}-2.36\%$
test_plain_set_stack_nested_inplace	0.3226ms	0.1763ms	5.6718 KOps/s	5.5901 KOps/s	$\color{#35bf28}+1.46\%$
test_items	38.4220μs	2.5145μs	397.7000 KOps/s	384.0106 KOps/s	$\color{#35bf28}+3.56\%$
test_items_nested	0.4837ms	0.2696ms	3.7089 KOps/s	3.5768 KOps/s	$\color{#35bf28}+3.69\%$
test_items_nested_locked	0.9098ms	0.2765ms	3.6162 KOps/s	3.6636 KOps/s	$\color{#d91a1a}-1.29\%$
test_items_nested_leaf	0.6702ms	0.1703ms	5.8704 KOps/s	5.8921 KOps/s	$\color{#d91a1a}-0.37\%$
test_items_stack_nested	2.0317ms	1.3447ms	743.6539 Ops/s	710.9828 Ops/s	$\color{#35bf28}+4.60\%$
test_items_stack_nested_leaf	1.4778ms	1.2084ms	827.5086 Ops/s	821.3985 Ops/s	$\color{#35bf28}+0.74\%$
test_items_stack_nested_locked	1.3780ms	0.8980ms	1.1136 KOps/s	1.1295 KOps/s	$\color{#d91a1a}-1.40\%$
test_keys	20.5990μs	3.8285μs	261.2001 KOps/s	261.1227 KOps/s	$\color{#35bf28}+0.03\%$
test_keys_nested	1.5135ms	0.1478ms	6.7663 KOps/s	6.6465 KOps/s	$\color{#35bf28}+1.80\%$
test_keys_nested_locked	0.2701ms	0.1508ms	6.6299 KOps/s	6.4554 KOps/s	$\color{#35bf28}+2.70\%$
test_keys_nested_leaf	0.2433ms	0.1299ms	7.7001 KOps/s	7.5034 KOps/s	$\color{#35bf28}+2.62\%$
test_keys_stack_nested	1.7075ms	1.2780ms	782.4497 Ops/s	769.4682 Ops/s	$\color{#35bf28}+1.69\%$
test_keys_stack_nested_leaf	1.9243ms	1.2671ms	789.2044 Ops/s	776.2733 Ops/s	$\color{#35bf28}+1.67\%$
test_keys_stack_nested_locked	1.0906ms	0.8097ms	1.2350 KOps/s	1.2086 KOps/s	$\color{#35bf28}+2.19\%$
test_values	11.1733μs	1.1413μs	876.1744 KOps/s	878.8501 KOps/s	$\color{#d91a1a}-0.30\%$
test_values_nested	95.0270μs	51.7850μs	19.3106 KOps/s	19.0740 KOps/s	$\color{#35bf28}+1.24\%$
test_values_nested_locked	0.1022ms	51.9090μs	19.2645 KOps/s	18.9048 KOps/s	$\color{#35bf28}+1.90\%$
test_values_nested_leaf	0.1182ms	46.3203μs	21.5888 KOps/s	21.0540 KOps/s	$\color{#35bf28}+2.54\%$
test_values_stack_nested	1.5516ms	1.0275ms	973.2326 Ops/s	943.0208 Ops/s	$\color{#35bf28}+3.20\%$
test_values_stack_nested_leaf	1.2723ms	1.0176ms	982.6748 Ops/s	951.3039 Ops/s	$\color{#35bf28}+3.30\%$
test_values_stack_nested_locked	1.1021ms	0.6088ms	1.6427 KOps/s	1.6032 KOps/s	$\color{#35bf28}+2.46\%$
test_membership	19.2860μs	1.3459μs	743.0239 KOps/s	754.8881 KOps/s	$\color{#d91a1a}-1.57\%$
test_membership_nested	44.6840μs	3.4505μs	289.8103 KOps/s	279.8114 KOps/s	$\color{#35bf28}+3.57\%$
test_membership_nested_leaf	44.0120μs	3.4812μs	287.2556 KOps/s	281.3367 KOps/s	$\color{#35bf28}+2.10\%$
test_membership_stacked_nested	41.8880μs	11.9702μs	83.5405 KOps/s	83.9095 KOps/s	$\color{#d91a1a}-0.44\%$
test_membership_stacked_nested_leaf	82.2900μs	11.9569μs	83.6335 KOps/s	83.6613 KOps/s	$\color{#d91a1a}-0.03\%$
test_membership_nested_last	31.7390μs	6.6059μs	151.3804 KOps/s	149.2434 KOps/s	$\color{#35bf28}+1.43\%$
test_membership_nested_leaf_last	31.9900μs	6.6184μs	151.0945 KOps/s	151.0293 KOps/s	$\color{#35bf28}+0.04\%$
test_membership_stacked_nested_last	0.3115ms	0.1757ms	5.6916 KOps/s	5.7379 KOps/s	$\color{#d91a1a}-0.81\%$
test_membership_stacked_nested_leaf_last	41.0570μs	13.8557μs	72.1722 KOps/s	71.2017 KOps/s	$\color{#35bf28}+1.36\%$
test_nested_getleaf	35.2260μs	10.4660μs	95.5472 KOps/s	93.1459 KOps/s	$\color{#35bf28}+2.58\%$
test_nested_get	0.1379ms	10.1866μs	98.1685 KOps/s	98.7233 KOps/s	$\color{#d91a1a}-0.56\%$
test_stacked_getleaf	0.5702ms	0.3961ms	2.5244 KOps/s	2.4920 KOps/s	$\color{#35bf28}+1.30\%$
test_stacked_get	0.5570ms	0.3631ms	2.7537 KOps/s	2.6913 KOps/s	$\color{#35bf28}+2.32\%$
test_nested_getitemleaf	32.3600μs	12.0764μs	82.8064 KOps/s	81.7524 KOps/s	$\color{#35bf28}+1.29\%$
test_nested_getitem	39.5440μs	11.5224μs	86.7876 KOps/s	86.1792 KOps/s	$\color{#35bf28}+0.71\%$
test_stacked_getitemleaf	0.5430ms	0.3987ms	2.5081 KOps/s	2.4374 KOps/s	$\color{#35bf28}+2.90\%$
test_stacked_getitem	0.5813ms	0.3668ms	2.7265 KOps/s	2.6488 KOps/s	$\color{#35bf28}+2.93\%$
test_lock_nested	2.8911ms	0.3510ms	2.8487 KOps/s	2.9671 KOps/s	$\color{#d91a1a}-3.99\%$
test_lock_stack_nested	0.1038s	6.4097ms	156.0135 Ops/s	165.8324 Ops/s	$\textbf{\color{#d91a1a}-5.92\%}$
test_unlock_nested	80.6742ms	0.4202ms	2.3796 KOps/s	2.9625 KOps/s	$\textbf{\color{#d91a1a}-19.68\%}$
test_unlock_stack_nested	93.1470ms	6.5051ms	153.7266 Ops/s	161.2109 Ops/s	$\color{#d91a1a}-4.64\%$
test_flatten_speed	0.7065ms	0.3681ms	2.7168 KOps/s	2.6834 KOps/s	$\color{#35bf28}+1.24\%$
test_unflatten_speed	0.6499ms	0.4557ms	2.1943 KOps/s	2.1698 KOps/s	$\color{#35bf28}+1.13\%$
test_common_ops	4.6082ms	0.7040ms	1.4205 KOps/s	1.4433 KOps/s	$\color{#d91a1a}-1.58\%$
test_creation	17.2320μs	1.8601μs	537.6038 KOps/s	529.7948 KOps/s	$\color{#35bf28}+1.47\%$
test_creation_empty	35.5460μs	11.3165μs	88.3667 KOps/s	98.7228 KOps/s	$\textbf{\color{#d91a1a}-10.49\%}$
test_creation_nested_1	53.1800μs	13.8665μs	72.1163 KOps/s	77.8712 KOps/s	$\textbf{\color{#d91a1a}-7.39\%}$
test_creation_nested_2	46.2270μs	17.2378μs	58.0120 KOps/s	62.5267 KOps/s	$\textbf{\color{#d91a1a}-7.22\%}$
test_clone	50.7850μs	13.1144μs	76.2520 KOps/s	74.5934 KOps/s	$\color{#35bf28}+2.22\%$
test_getitem[int]	34.6350μs	11.3940μs	87.7651 KOps/s	89.0962 KOps/s	$\color{#d91a1a}-1.49\%$
test_getitem[slice_int]	75.8420μs	22.2165μs	45.0115 KOps/s	42.4216 KOps/s	$\textbf{\color{#35bf28}+6.11\%}$
test_getitem[range]	99.1160μs	42.2291μs	23.6803 KOps/s	22.4702 KOps/s	$\textbf{\color{#35bf28}+5.39\%}$
test_getitem[tuple]	48.5010μs	18.3633μs	54.4565 KOps/s	53.1154 KOps/s	$\color{#35bf28}+2.52\%$
test_getitem[list]	0.2375ms	37.3478μs	26.7753 KOps/s	26.0327 KOps/s	$\color{#35bf28}+2.85\%$
test_setitem_dim[int]	64.4000μs	31.4305μs	31.8162 KOps/s	32.8649 KOps/s	$\color{#d91a1a}-3.19\%$
test_setitem_dim[slice_int]	0.1006ms	56.7864μs	17.6099 KOps/s	17.8685 KOps/s	$\color{#d91a1a}-1.45\%$
test_setitem_dim[range]	0.1782ms	79.6253μs	12.5588 KOps/s	12.9577 KOps/s	$\color{#d91a1a}-3.08\%$
test_setitem_dim[tuple]	0.1647ms	46.3088μs	21.5942 KOps/s	22.2982 KOps/s	$\color{#d91a1a}-3.16\%$
test_setitem	98.7740μs	20.0773μs	49.8075 KOps/s	50.8272 KOps/s	$\color{#d91a1a}-2.01\%$
test_set	0.1610ms	19.5332μs	51.1949 KOps/s	52.3089 KOps/s	$\color{#d91a1a}-2.13\%$
test_set_shared	4.6338ms	0.1421ms	7.0359 KOps/s	7.1474 KOps/s	$\color{#d91a1a}-1.56\%$
test_update	0.1508ms	22.9447μs	43.5830 KOps/s	44.7617 KOps/s	$\color{#d91a1a}-2.63\%$
test_update_nested	94.5860μs	30.2752μs	33.0304 KOps/s	33.8327 KOps/s	$\color{#d91a1a}-2.37\%$
test_set_nested	0.1012ms	21.3923μs	46.7458 KOps/s	47.2618 KOps/s	$\color{#d91a1a}-1.09\%$
test_set_nested_new	0.1035ms	25.1324μs	39.7893 KOps/s	40.5162 KOps/s	$\color{#d91a1a}-1.79\%$
test_select	0.1520ms	38.6659μs	25.8626 KOps/s	26.2134 KOps/s	$\color{#d91a1a}-1.34\%$
test_select_nested	0.1430ms	58.5403μs	17.0822 KOps/s	17.3653 KOps/s	$\color{#d91a1a}-1.63\%$
test_exclude_nested	0.2688ms	0.1176ms	8.5070 KOps/s	8.3836 KOps/s	$\color{#35bf28}+1.47\%$
test_empty[True]	0.6975ms	0.4114ms	2.4305 KOps/s	2.4672 KOps/s	$\color{#d91a1a}-1.49\%$
test_empty[False]	5.3420μs	1.0623μs	941.3264 KOps/s	956.5947 KOps/s	$\color{#d91a1a}-1.60\%$
test_unbind_speed	0.2951ms	0.2502ms	3.9975 KOps/s	4.0054 KOps/s	$\color{#d91a1a}-0.20\%$
test_unbind_speed_stack0	89.2733ms	3.5346ms	282.9199 Ops/s	323.6637 Ops/s	$\textbf{\color{#d91a1a}-12.59\%}$
test_unbind_speed_stack1	31.3590μs	1.9835μs	504.1560 KOps/s	516.1181 KOps/s	$\color{#d91a1a}-2.32\%$
test_split	2.2472ms	1.4913ms	670.5571 Ops/s	607.4135 Ops/s	$\textbf{\color{#35bf28}+10.40\%}$
test_chunk	83.7681ms	1.6195ms	617.4903 Ops/s	599.4367 Ops/s	$\color{#35bf28}+3.01\%$
test_creation[device0]	0.2215ms	0.1031ms	9.7031 KOps/s	9.6332 KOps/s	$\color{#35bf28}+0.73\%$
test_creation_from_tensor	3.2537ms	84.0028μs	11.9044 KOps/s	12.0981 KOps/s	$\color{#d91a1a}-1.60\%$
test_add_one[memmap_tensor0]	0.2200ms	5.4291μs	184.1916 KOps/s	192.5109 KOps/s	$\color{#d91a1a}-4.32\%$
test_contiguous[memmap_tensor0]	0.1317ms	0.6707μs	1.4909 MOps/s	1.5001 MOps/s	$\color{#d91a1a}-0.61\%$
test_stack[memmap_tensor0]	0.1165ms	4.7008μs	212.7314 KOps/s	278.6043 KOps/s	$\textbf{\color{#d91a1a}-23.64\%}$
test_memmaptd_index	0.9892ms	0.2392ms	4.1810 KOps/s	4.1370 KOps/s	$\color{#35bf28}+1.06\%$
test_memmaptd_index_astensor	0.7340ms	0.2996ms	3.3382 KOps/s	3.2808 KOps/s	$\color{#35bf28}+1.75\%$
test_memmaptd_index_op	0.9857ms	0.6112ms	1.6362 KOps/s	1.6960 KOps/s	$\color{#d91a1a}-3.53\%$
test_serialize_model	0.1894s	0.1136s	8.8051 Ops/s	8.6483 Ops/s	$\color{#35bf28}+1.81\%$
test_serialize_model_pickle	0.4505s	0.3780s	2.6452 Ops/s	2.6281 Ops/s	$\color{#35bf28}+0.65\%$
test_serialize_weights	0.1796s	0.1101s	9.0842 Ops/s	8.8926 Ops/s	$\color{#35bf28}+2.15\%$
test_serialize_weights_returnearly	0.2024s	0.1325s	7.5481 Ops/s	8.0897 Ops/s	$\textbf{\color{#d91a1a}-6.69\%}$
test_serialize_weights_pickle	0.8498s	0.5638s	1.7738 Ops/s	2.4378 Ops/s	$\textbf{\color{#d91a1a}-27.24\%}$
test_serialize_weights_filesystem	99.4781ms	92.9084ms	10.7633 Ops/s	9.4121 Ops/s	$\textbf{\color{#35bf28}+14.36\%}$
test_serialize_model_filesystem	0.1655s	0.1027s	9.7385 Ops/s	10.2303 Ops/s	$\color{#d91a1a}-4.81\%$
test_reshape_pytree	68.2670μs	20.4385μs	48.9272 KOps/s	47.7879 KOps/s	$\color{#35bf28}+2.38\%$
test_reshape_td	0.1175ms	29.4610μs	33.9432 KOps/s	32.8238 KOps/s	$\color{#35bf28}+3.41\%$
test_view_pytree	48.1300μs	20.4064μs	49.0042 KOps/s	47.4891 KOps/s	$\color{#35bf28}+3.19\%$
test_view_td	0.1033s	12.7727μs	78.2917 KOps/s	84.0336 KOps/s	$\textbf{\color{#d91a1a}-6.83\%}$
test_unbind_pytree	61.0640μs	23.9171μs	41.8110 KOps/s	41.3739 KOps/s	$\color{#35bf28}+1.06\%$
test_unbind_td	0.5294ms	35.8772μs	27.8729 KOps/s	27.6950 KOps/s	$\color{#35bf28}+0.64\%$
test_split_pytree	55.4740μs	23.6395μs	42.3021 KOps/s	41.7524 KOps/s	$\color{#35bf28}+1.32\%$
test_split_td	0.1198ms	39.9214μs	25.0492 KOps/s	25.4934 KOps/s	$\color{#d91a1a}-1.74\%$
test_add_pytree	70.9330μs	29.6391μs	33.7393 KOps/s	34.3075 KOps/s	$\color{#d91a1a}-1.66\%$
test_add_td	0.1192ms	53.7820μs	18.5936 KOps/s	19.5074 KOps/s	$\color{#d91a1a}-4.68\%$
test_distributed	0.1804ms	0.1007ms	9.9330 KOps/s	9.7275 KOps/s	$\color{#35bf28}+2.11\%$
test_tdmodule	0.3335ms	22.8071μs	43.8461 KOps/s	46.8928 KOps/s	$\textbf{\color{#d91a1a}-6.50\%}$
test_tdmodule_dispatch	0.2040ms	45.3669μs	22.0425 KOps/s	23.0274 KOps/s	$\color{#d91a1a}-4.28\%$
test_tdseq	47.8390μs	25.9938μs	38.4707 KOps/s	39.8847 KOps/s	$\color{#d91a1a}-3.55\%$
test_tdseq_dispatch	0.1394ms	49.2058μs	20.3228 KOps/s	20.4322 KOps/s	$\color{#d91a1a}-0.54\%$
test_instantiation_functorch	2.0477ms	1.3310ms	751.2993 Ops/s	753.4331 Ops/s	$\color{#d91a1a}-0.28\%$
test_instantiation_td	1.5745ms	1.0014ms	998.6171 Ops/s	865.0164 Ops/s	$\textbf{\color{#35bf28}+15.44\%}$
test_exec_functorch	0.2443ms	0.1574ms	6.3526 KOps/s	6.1757 KOps/s	$\color{#35bf28}+2.86\%$
test_exec_functional_call	0.2932ms	0.1446ms	6.9166 KOps/s	6.7845 KOps/s	$\color{#35bf28}+1.95\%$
test_exec_td	0.2139ms	0.1424ms	7.0213 KOps/s	6.7949 KOps/s	$\color{#35bf28}+3.33\%$
test_exec_td_decorator	0.8072ms	0.2001ms	4.9975 KOps/s	4.7417 KOps/s	$\textbf{\color{#35bf28}+5.40\%}$
test_vmap_mlp_speed[True-True]	1.2776ms	0.8836ms	1.1317 KOps/s	1.0869 KOps/s	$\color{#35bf28}+4.12\%$
test_vmap_mlp_speed[True-False]	0.5972ms	0.4733ms	2.1127 KOps/s	2.0872 KOps/s	$\color{#35bf28}+1.22\%$
test_vmap_mlp_speed[False-True]	1.1784ms	0.7712ms	1.2967 KOps/s	1.2374 KOps/s	$\color{#35bf28}+4.80\%$
test_vmap_mlp_speed[False-False]	0.6515ms	0.3873ms	2.5822 KOps/s	2.5283 KOps/s	$\color{#35bf28}+2.13\%$
test_vmap_mlp_speed_decorator[True-True]	2.8958ms	2.3080ms	433.2700 Ops/s	424.7368 Ops/s	$\color{#35bf28}+2.01\%$
test_vmap_mlp_speed_decorator[True-False]	0.9766ms	0.5430ms	1.8416 KOps/s	1.8185 KOps/s	$\color{#35bf28}+1.27\%$
test_vmap_mlp_speed_decorator[False-True]	2.2307ms	1.8856ms	530.3322 Ops/s	527.0176 Ops/s	$\color{#35bf28}+0.63\%$
test_vmap_mlp_speed_decorator[False-False]	0.7789ms	0.4187ms	2.3884 KOps/s	2.3465 KOps/s	$\color{#35bf28}+1.79\%$