Bugfix/doc errors

[christofbradly]

fix recent doc errors

[coveralls]

Pull Request Test Coverage Report for Build 6243004025

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 94.142%

---

Totals
Change from base Build 6222084478:	0.0%
Covered Lines:	4982
Relevant Lines:	5292

---

💛 - Coveralls

[mtsch]

Thanks!

[github-actions]

Benchmark result

Judge result

Benchmark Report for /home/runner/work/Rimu.jl/Rimu.jl

Job Properties

• Time of benchmarks:

• Target: 20 Sep 2023 - 02:07
• Baseline: 20 Sep 2023 - 02:18

• Package commits:

• Target: bfd42b
• Baseline: 1ff159

• Julia commits:

• Target: bed2cd
• Baseline: bed2cd

• Julia command flags:

• Target: None
• Baseline: None

• Environment variables:

• Target: None
• Baseline: None

Results

A ratio greater than 1.0 denotes a possible regression (marked with ❌), while a ratio less
than 1.0 denotes a possible improvement (marked with ✅). Only significant results - results
that indicate possible regressions or improvements - are shown below (thus, an empty table means that all
benchmark results remained invariant between builds).

ID	time ratio	memory ratio
["Rimu", "Exact", "Diagonalization", "Bose-Hubbard in momentum space"]	1.06 (5%) ❌	1.00 (1%)
["Rimu", "FCIQMC", "(10, 20) Mom space with projected energy and initiator"]	1.06 (5%) ❌	1.00 (1%)

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["Rimu", "Exact", "Diagonalization"]
• ["Rimu", "Exact", "Multiplication"]
• ["Rimu", "FCIQMC"]

Julia versioninfo

Target

Julia Version 1.9.3
Commit bed2cd540a1 (2023-08-24 14:43 UTC)
Build Info:
 Official https://julialang.org/ release
Platform Info:
 OS: Linux (x86_64-linux-gnu)
 Ubuntu 22.04.3 LTS
 uname: Linux 6.2.0-1011-azure #11~22.04.1-Ubuntu SMP Wed Aug 23 19:26:19 UTC 2023 x86_64 x86_64
 CPU: Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz: 
 speed user nice sys idle irq
 #1 2095 MHz 7283 s 0 s 291 s 2131 s 0 s
 #2 2095 MHz 3443 s 0 s 343 s 5892 s 0 s
 Memory: 6.759757995605469 GB (5101.140625 MB free)
 Uptime: 977.42 sec
 Load Avg: 1.02 1.13 0.94
 WORD_SIZE: 64
 LIBM: libopenlibm
 LLVM: libLLVM-14.0.6 (ORCJIT, skylake-avx512)
 Threads: 1 on 2 virtual cores

Baseline

Julia Version 1.9.3
Commit bed2cd540a1 (2023-08-24 14:43 UTC)
Build Info:
 Official https://julialang.org/ release
Platform Info:
 OS: Linux (x86_64-linux-gnu)
 Ubuntu 22.04.3 LTS
 uname: Linux 6.2.0-1011-azure #11~22.04.1-Ubuntu SMP Wed Aug 23 19:26:19 UTC 2023 x86_64 x86_64
 CPU: Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz: 
 speed user nice sys idle irq
 #1 2095 MHz 7413 s 0 s 405 s 8344 s 0 s
 #2 2095 MHz 9835 s 0 s 360 s 5984 s 0 s
 Memory: 6.759757995605469 GB (5043.17578125 MB free)
 Uptime: 1627.58 sec
 Load Avg: 1.02 1.03 1.0
 WORD_SIZE: 64
 LIBM: libopenlibm
 LLVM: libLLVM-14.0.6 (ORCJIT, skylake-avx512)
 Threads: 1 on 2 virtual cores

---

Target result

Benchmark Report for /home/runner/work/Rimu.jl/Rimu.jl

Job Properties

• Time of benchmark: 20 Sep 2023 - 2:7
• Package commit: bfd42b
• Julia commit: bed2cd
• Julia command flags: None
• Environment variables: None

Results

Below is a table of this job's results, obtained by running the benchmarks.
The values listed in the ID column have the structure [parent_group, child_group, ..., key], and can be used to
index into the BaseBenchmarks suite to retrieve the corresponding benchmarks.
The percentages accompanying time and memory values in the below table are noise tolerances. The "true"
time/memory value for a given benchmark is expected to fall within this percentage of the reported value.
An empty cell means that the value was zero.

ID	time	GC time	memory	allocations
["Rimu", "Exact", "Diagonalization", "2D Hubbard"]	3.107 s (5%)	2.142 ms	48.21 MiB (1%)	1469
["Rimu", "Exact", "Diagonalization", "Bose-Hubbard in momentum space"]	26.015 s (5%)	59.338 ms	357.29 MiB (1%)	2003388
["Rimu", "Exact", "Multiplication", "Momentum space"]	1.155 s (5%)		5.42 MiB (1%)	99
["Rimu", "Exact", "Multiplication", "Transcorrelated"]	6.409 s (5%)		733.52 KiB (1%)	113
["Rimu", "FCIQMC", "(10, 20) Mom space with projected energy and initiator"]	40.980 s (5%)	85.427 ms	35.76 MiB (1%)	984784
["Rimu", "FCIQMC", "(4+1, 11) 2C Mom space with G2Correlators"]	35.690 s (5%)		23.21 MiB (1%)	638731
["Rimu", "FCIQMC", "(50, 50) Real space"]	33.265 s (5%)	22.599 ms	28.08 MiB (1%)	99734

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["Rimu", "Exact", "Diagonalization"]
• ["Rimu", "Exact", "Multiplication"]
• ["Rimu", "FCIQMC"]

Julia versioninfo

Julia Version 1.9.3
Commit bed2cd540a1 (2023-08-24 14:43 UTC)
Build Info:
 Official https://julialang.org/ release
Platform Info:
 OS: Linux (x86_64-linux-gnu)
 Ubuntu 22.04.3 LTS
 uname: Linux 6.2.0-1011-azure #11~22.04.1-Ubuntu SMP Wed Aug 23 19:26:19 UTC 2023 x86_64 x86_64
 CPU: Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz: 
 speed user nice sys idle irq
 #1 2095 MHz 7283 s 0 s 291 s 2131 s 0 s
 #2 2095 MHz 3443 s 0 s 343 s 5892 s 0 s
 Memory: 6.759757995605469 GB (5101.140625 MB free)
 Uptime: 977.42 sec
 Load Avg: 1.02 1.13 0.94
 WORD_SIZE: 64
 LIBM: libopenlibm
 LLVM: libLLVM-14.0.6 (ORCJIT, skylake-avx512)
 Threads: 1 on 2 virtual cores

---

Baseline result

Benchmark Report for /home/runner/work/Rimu.jl/Rimu.jl

Job Properties

• Time of benchmark: 20 Sep 2023 - 2:18
• Package commit: 1ff159
• Julia commit: bed2cd
• Julia command flags: None
• Environment variables: None

Results

Below is a table of this job's results, obtained by running the benchmarks.
The values listed in the ID column have the structure [parent_group, child_group, ..., key], and can be used to
index into the BaseBenchmarks suite to retrieve the corresponding benchmarks.
The percentages accompanying time and memory values in the below table are noise tolerances. The "true"
time/memory value for a given benchmark is expected to fall within this percentage of the reported value.
An empty cell means that the value was zero.

ID	time	GC time	memory	allocations
["Rimu", "Exact", "Diagonalization", "2D Hubbard"]	2.990 s (5%)		48.21 MiB (1%)	1469
["Rimu", "Exact", "Diagonalization", "Bose-Hubbard in momentum space"]	24.658 s (5%)	61.281 ms	357.29 MiB (1%)	2003388
["Rimu", "Exact", "Multiplication", "Momentum space"]	1.144 s (5%)		5.42 MiB (1%)	99
["Rimu", "Exact", "Multiplication", "Transcorrelated"]	6.216 s (5%)		733.52 KiB (1%)	113
["Rimu", "FCIQMC", "(10, 20) Mom space with projected energy and initiator"]	38.728 s (5%)		35.76 MiB (1%)	984656
["Rimu", "FCIQMC", "(4+1, 11) 2C Mom space with G2Correlators"]	35.280 s (5%)		23.21 MiB (1%)	638715
["Rimu", "FCIQMC", "(50, 50) Real space"]	32.948 s (5%)		28.08 MiB (1%)	99731

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["Rimu", "Exact", "Diagonalization"]
• ["Rimu", "Exact", "Multiplication"]
• ["Rimu", "FCIQMC"]

Julia versioninfo

Julia Version 1.9.3
Commit bed2cd540a1 (2023-08-24 14:43 UTC)
Build Info:
 Official https://julialang.org/ release
Platform Info:
 OS: Linux (x86_64-linux-gnu)
 Ubuntu 22.04.3 LTS
 uname: Linux 6.2.0-1011-azure #11~22.04.1-Ubuntu SMP Wed Aug 23 19:26:19 UTC 2023 x86_64 x86_64
 CPU: Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz: 
 speed user nice sys idle irq
 #1 2095 MHz 7413 s 0 s 405 s 8344 s 0 s
 #2 2095 MHz 9835 s 0 s 360 s 5984 s 0 s
 Memory: 6.759757995605469 GB (5043.17578125 MB free)
 Uptime: 1627.58 sec
 Load Avg: 1.02 1.03 1.0
 WORD_SIZE: 64
 LIBM: libopenlibm
 LLVM: libLLVM-14.0.6 (ORCJIT, skylake-avx512)
 Threads: 1 on 2 virtual cores

---

Runtime information

Runtime Info
BLAS #threads	1
BLAS.vendor()	lbt
Sys.CPU_THREADS	2

lscpu output:

Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Address sizes: 46 bits physical, 48 bits virtual
Byte Order: Little Endian
CPU(s): 2
On-line CPU(s) list: 0,1
Vendor ID: GenuineIntel
Model name: Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz
CPU family: 6
Model: 85
Thread(s) per core: 1
Core(s) per socket: 2
Socket(s): 1
Stepping: 4
BogoMIPS: 4190.15
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology cpuid pni pclmulqdq ssse3 fma cx16 pcid sse4_1 sse4_2 movbe popcnt aes xsave avx f16c rdrand hypervisor lahf_lm abm 3dnowprefetch invpcid_single pti fsgsbase bmi1 hle avx2 smep bmi2 erms invpcid rtm avx512f avx512dq rdseed adx smap clflushopt avx512cd avx512bw avx512vl xsaveopt xsavec xsaves md_clear
Hypervisor vendor: Microsoft
Virtualization type: full
L1d cache: 64 KiB (2 instances)
L1i cache: 64 KiB (2 instances)
L2 cache: 2 MiB (2 instances)
L3 cache: 35.8 MiB (1 instance)
NUMA node(s): 1
NUMA node0 CPU(s): 0,1
Vulnerability Gather data sampling: Unknown: Dependent on hypervisor status
Vulnerability Itlb multihit: KVM: Mitigation: VMX unsupported
Vulnerability L1tf: Mitigation; PTE Inversion
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT Host state unknown
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Vulnerable: Clear CPU buffers attempted, no microcode; SMT Host state unknown
Vulnerability Retbleed: Vulnerable
Vulnerability Spec store bypass: Vulnerable
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; Retpolines, STIBP disabled, RSB filling, PBRSB-eIBRS Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT Host state unknown

Cpu Property	Value
Brand	Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz
Vendor	:Intel
Architecture	:Skylake
Model	Family: 0x06, Model: 0x55, Stepping: 0x04, Type: 0x00
Cores	2 physical cores, 2 logical cores (on executing CPU)
	No Hyperthreading hardware capability detected
Clock Frequencies	Not supported by CPU
Data Cache	Level 1:3 : (32, 1024, 36608) kbytes
	64 byte cache line size
Address Size	48 bits virtual, 46 bits physical
SIMD	512 bit = 64 byte max. SIMD vector size
Time Stamp Counter	TSC is accessible via rdtsc
	TSC increased at every clock cycle (non-invariant TSC)
Perf. Monitoring	Performance Monitoring Counters (PMC) are not supported
Hypervisor	Yes, Microsoft

[joachimbrand]

Thanks for this!