Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various documentation improvements #299

Merged
merged 7 commits into from
Jan 26, 2022

Conversation

itamarst
Copy link
Collaborator

@itamarst itamarst commented Jan 26, 2022

Fixes #185
Fixes #291
Fixes #292
Fixes #298

@github-actions
Copy link

Benchmark results

diff --git a/benchmarks/results/lots-of-peaks.json b/benchmarks/results/lots-of-peaks.json
index 383499f..38d1945 100644
--- a/benchmarks/results/lots-of-peaks.json
+++ b/benchmarks/results/lots-of-peaks.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"3771157 (188.06264867688517%)",-]{+"4515115 (205.3123171221804%)",+}
    "D1mw": [-"2763734 (1002.7001956474165%)",-]{+"3869441 (1365.4329910393094%)",+}
    "DLmr": [-"1492746 (2257.3344509639564%)",-]{+"2119605 (3561.0881598928822%)",+}
    "DLmw": [-"1858942 (1333.7673887649994%)",-]{+"2938332 (2051.926130135849%)",+}
    "Dr": [-"231060633 (375.8621692938787%)",-]{+"223635305 (371.376285134268%)",+}
    "Dw": [-"88001037 (338.04076205255154%)",-]{+"84702173 (336.42208113306407%)",+}
    "I1mr": [-"3555117 (1291.257363437142%)",-]{+"4104098 (1449.4551671982376%)",+}
    "ILmr": [-"14685 (224.7663551401869%)",-]{+"16659 (241.34566434753097%)",+}
    "Ir": [-"872039764 (403.39198904097907%)",-]{+"851570163 (399.59372316774807%)",+}
    "Overall": [-"1332452656 (406.55387644593173%)"-]{+"1362100137 (417.6746268629565%)"+}
}
diff --git a/benchmarks/results/multithreading-1.json b/benchmarks/results/multithreading-1.json
index 2d9d2d5..e4a2734 100644
--- a/benchmarks/results/multithreading-1.json
+++ b/benchmarks/results/multithreading-1.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"1866984 (413.64545831772375%)",-]{+"1843162 (407.19213070601313%)",+}
    "D1mw": [-"393456 (455.7661355950594%)",-]{+"395485 (458.6449869413813%)",+}
    "DLmr": [-"59324 (493.26483261518064%)",-]{+"58261 (482.9181728557345%)",+}
    "DLmw": [-"77459 (220.9427598913281%)",-]{+"77667 (221.49896752393468%)",+}
    "Dr": [-"77161209 (571.2328286082947%)",-]{+"68028981 (529.1782831904947%)",+}
    "Dw": [-"30820902 (440.2169730406361%)",-]{+"26690982 (411.5576879371379%)",+}
    "I1mr": [-"1638950 (586.5692113122628%)",-]{+"1624601 (573.1190718181845%)",+}
    "ILmr": [-"7958 (171.83607149304927%)",-]{+"8608 (176.96021457308896%)",+}
    "Ir": [-"254542209 (491.30873094686683%)",-]{+"231319784 (464.82862075947446%)",+}
    "Overall": [-"382464110 (492.83707107089475%)"-]{+"345828819 (465.00112736687277%)"+}
}
diff --git a/benchmarks/results/pystone.json b/benchmarks/results/pystone.json
index 3970408..6382099 100644
--- a/benchmarks/results/pystone.json
+++ b/benchmarks/results/pystone.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"4542966 (144.07376585255872%)",-]{+"6889703 (175.5486587780525%)",+}
    "D1mw": [-"1628141 (267.75567903740483%)",-]{+"1002885 (172.5743773663552%)",+}
    "DLmr": [-"32802 (331.7507418397626%)",-]{+"32626 (328.8740792704314%)",+}
    "DLmw": [-"65725 (241.46577701248387%)",-]{+"66360 (243.1529899042195%)",+}
    "Dr": [-"367659717 (157.6310977517437%)",-]{+"314314602 (149.44594390121%)",+}
    "Dw": [-"143586175 (159.9837295595579%)",-]{+"128722499 (154.1974495003637%)",+}
    "I1mr": [-"8784651 (214.74165578852526%)",-]{+"8782269 (211.69037608693523%)",+}
    "ILmr": [-"7924 (170.99086185271457%)",-]{+"8530 (175.6541019955654%)",+}
    "Ir": [-"1160233461 (157.01681262908485%)",-]{+"1063192189 (152.37115490466022%)",+}
    "Overall": [-"1734495915 (158.00764418609307%)"-]{+"1576154198 (152.91053148199458%)"+}
}
diff --git a/benchmarks/results/version.txt b/benchmarks/results/version.txt
index d8f4897..cc5c82d 100644
--- a/benchmarks/results/version.txt
+++ b/benchmarks/results/version.txt
@@ -1 +1 @@
[-2021.9.2.dev9+gc3af8e6.d20211105-]{+2021.12.3.dev17+g4ec990a.d20220126+}

@github-actions
Copy link

Benchmark results

diff --git a/benchmarks/results/lots-of-peaks.json b/benchmarks/results/lots-of-peaks.json
index 383499f..0ba193c 100644
--- a/benchmarks/results/lots-of-peaks.json
+++ b/benchmarks/results/lots-of-peaks.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"3771157 (188.06264867688517%)",-]{+"4504415 (205.06277062133398%)",+}
    "D1mw": [-"2763734 (1002.7001956474165%)",-]{+"3869545 (1365.462863945111%)",+}
    "DLmr": [-"1492746 (2257.3344509639564%)",-]{+"2105107 (3537.414477229307%)",+}
    "DLmw": [-"1858942 (1333.7673887649994%)",-]{+"2938791 (2052.231042614674%)",+}
    "Dr": [-"231060633 (375.8621692938787%)",-]{+"223636339 (371.37760243840967%)",+}
    "Dw": [-"88001037 (338.04076205255154%)",-]{+"84702414 (336.4227538161788%)",+}
    "I1mr": [-"3555117 (1291.257363437142%)",-]{+"4108349 (1450.8173921048997%)",+}
    "ILmr": [-"14685 (224.7663551401869%)",-]{+"16676 (241.48990327507212%)",+}
    "Ir": [-"872039764 (403.39198904097907%)",-]{+"851586395 (399.59953498848114%)",+}
    "Overall": [-"1332452656 (406.55387644593173%)"-]{+"1361671604 (417.574744099374%)"+}
}
diff --git a/benchmarks/results/multithreading-1.json b/benchmarks/results/multithreading-1.json
index 2d9d2d5..af41c9c 100644
--- a/benchmarks/results/multithreading-1.json
+++ b/benchmarks/results/multithreading-1.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"1866984 (413.64545831772375%)",-]{+"1839195 (406.528923829222%)",+}
    "D1mw": [-"393456 (455.7661355950594%)",-]{+"394164 (457.44704004643063%)",+}
    "DLmr": [-"59324 (493.26483261518064%)",-]{+"58295 (483.1416365428853%)",+}
    "DLmw": [-"77459 (220.9427598913281%)",-]{+"77608 (221.40667042112509%)",+}
    "Dr": [-"77161209 (571.2328286082947%)",-]{+"68027075 (529.1653652254615%)",+}
    "Dw": [-"30820902 (440.2169730406361%)",-]{+"26690436 (411.5506600061982%)",+}
    "I1mr": [-"1638950 (586.5692113122628%)",-]{+"1624887 (573.2133860262746%)",+}
    "ILmr": [-"7958 (171.83607149304927%)",-]{+"8611 (176.97327254849378%)",+}
    "Ir": [-"254542209 (491.30873094686683%)",-]{+"231316066 (464.8216751542404%)",+}
    "Overall": [-"382464110 (492.83707107089475%)"-]{+"345801981 (464.9717113714697%)"+}
}
diff --git a/benchmarks/results/pystone.json b/benchmarks/results/pystone.json
index 3970408..9f0dbd7 100644
--- a/benchmarks/results/pystone.json
+++ b/benchmarks/results/pystone.json
@@ -1,12 +1,12 @@
{
    "D1mr": [-"4542966 (144.07376585255872%)",-]{+"6174261 (167.702828507673%)",+}
    "D1mw": [-"1628141 (267.75567903740483%)",-]{+"973892 (170.4783725361495%)",+}
    "DLmr": [-"32802 (331.7507418397626%)",-]{+"32569 (328.5062793797797%)",+}
    "DLmw": [-"65725 (241.46577701248387%)",-]{+"66352 (243.12955692652832%)",+}
    "Dr": [-"367659717 (157.6310977517437%)",-]{+"314314576 (149.44594027776884%)",+}
    "Dw": [-"143586175 (159.9837295595579%)",-]{+"128722762 (154.1975586367887%)",+}
    "I1mr": [-"8784651 (214.74165578852526%)",-]{+"8782546 (211.69385627870705%)",+}
    "ILmr": [-"7924 (170.99086185271457%)",-]{+"8542 (175.76053215077604%)",+}
    "Ir": [-"1160233461 (157.01681262908485%)",-]{+"1062916718 (152.35752897998202%)",+}
    "Overall": [-"1734495915 (158.00764418609307%)"-]{+"1572900742 (152.80127209668413%)"+}
}
diff --git a/benchmarks/results/version.txt b/benchmarks/results/version.txt
index d8f4897..5353ba4 100644
--- a/benchmarks/results/version.txt
+++ b/benchmarks/results/version.txt
@@ -1 +1 @@
[-2021.9.2.dev9+gc3af8e6.d20211105-]{+2021.12.3.dev18+gd0b6ce5.d20220126+}

@itamarst itamarst merged commit 9244783 into master Jan 26, 2022
@itamarst itamarst deleted the various-documentation-improvements branch January 26, 2022 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant