Docs

[abhro]

No description provided.

[Moelf]

hi, this looks like purely formatting change?

[abhro]

Some of it, but there are some changes that I still haven't committed, ergo the draft phase 😅

[Moelf]

thanks in advance!

[github-actions]

Benchmark Results (Julia v1)

Time benchmarks

	main	28c24ef...	main / 28c24ef...
Non-Uniform Binning/One-shot Gaussian input	16.2 ± 0.067 ms	16.4 ± 0.043 ms	0.989 ± 0.0048
Non-Uniform Binning/One-shot Gaussian input with weights	17 ± 0.047 ms	16.9 ± 0.057 ms	1 ± 0.0044
Non-Uniform Binning/One-shot Uniform input	15.6 ± 0.044 ms	15.5 ± 0.041 ms	1 ± 0.0039
Non-Uniform Binning/One-shot Uniform input with weights	16.2 ± 0.087 ms	16.2 ± 0.062 ms	1 ± 0.0066
Uniform Binning/One-shot Gaussian input	7.41 ± 0.052 ms	7.38 ± 0.052 ms	1 ± 0.01
Uniform Binning/One-shot Gaussian input with weights	10.6 ± 0.046 ms	10.6 ± 0.14 ms	0.998 ± 0.014
Uniform Binning/One-shot Uniform input	1.74 ± 0.0068 ms	1.74 ± 0.0075 ms	1 ± 0.0058
Uniform Binning/One-shot Uniform input with weights	7.81 ± 0.025 ms	7.75 ± 0.027 ms	1.01 ± 0.0047
Uniform Binning/atomic_push!-loop Gaussian input	12 ± 0.052 ms	12 ± 0.04 ms	0.994 ± 0.0054
Uniform Binning/push!-loop Uniform input	2.03 ± 0.013 ms	2.03 ± 0.014 ms	1 ± 0.0094
time_to_load	0.285 ± 0.0054 s	0.282 ± 0.0011 s	1.01 ± 0.02

Memory benchmarks

	main	28c24ef...	main / 28c24ef...
Non-Uniform Binning/One-shot Gaussian input	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Gaussian input with weights	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Uniform input	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Uniform input with weights	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Uniform Binning/One-shot Gaussian input	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Gaussian input with weights	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Uniform input	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Uniform input with weights	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/atomic_push!-loop Gaussian input	7 allocs: 0.344 kB	7 allocs: 0.344 kB	1
Uniform Binning/push!-loop Uniform input	7 allocs: 0.344 kB	7 allocs: 0.344 kB	1
time_to_load	0.145 k allocs: 11 kB	0.145 k allocs: 11 kB	1