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

Peak performance paper #17

Merged
merged 46 commits into from
Oct 13, 2024
Merged

Peak performance paper #17

merged 46 commits into from
Oct 13, 2024

Conversation

Y0dler
Copy link
Collaborator

@Y0dler Y0dler commented Aug 12, 2024

Add the PeakPerformance paper and associated files to the repository in order to submit it to JOSS.

Copy link
Member

@michaelosthege michaelosthege left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍👍 with a few smaller edits

What is the raw format for that table? Inkscape SVG?
If we can print it to a PDF that would render the text selectable for the output.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/summary_joint.png Outdated Show resolved Hide resolved
@michaelosthege
Copy link
Member

I tried to format Table 2 as a pandoc grid table.

Using VS Code multiline cursor this was reasonably comfortable to edit.

I used https://pandoc.org/try/ to convert the table to HTML and viewed it using https://html.onlineviewer.net/ and got something that might actually compile 👀

@michaelosthege michaelosthege force-pushed the peak-performance-paper branch 4 times, most recently from 1f492d7 to 7c2fe31 Compare August 20, 2024 14:12
@michaelosthege
Copy link
Member

With the following raw markup this is the best I got:

+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
| parameter          | skew normal model                             | double normal model                            |
|                    +-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    | mean        | sd        | 3 %      | 97 %     | mean        | sd         | 3 %      | 97 %     |
+:===================+============:+==========:+=========:+=========:+============:+===========:+=========:+=========:+
| intercept          | -43.94      | 7.41      | -57.88   | -30.02   | 1115.40     | 38.69      | 1040.14  | 1185.07  |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
| slope              | 6.66        | 0.51      | 5.71     | 7.63     | -21.65      | 3.09       | -27.50   |-15.94    |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
| noise              | 103.63      | 7.51      | 89.50    | 117.26   |  118.63     | 8.01       | 103.52   | 133.29   |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    |             |           |          |          |  __11.73__  | __0.02__   | 11.70    | 11.76    |
| mean               | __25.95__   | __0.01__  | 25.93    | 25.97    +-------------+------------+----------+----------+
|                    |             |           |          |          |  __12.43__  | __0.01__   | 12.42    | 12.45    |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    |             |           |          |          |  __317.16__ | __28.84__  | 263.23   | 370.56   |
| area               | __1512.32__ | __37.31__ | 1141.25  | 1581.37  +-------------+------------+----------+----------+
|                    |             |           |          |          |  __674.34__ | __26.34__  | 623.47   | 722.88   |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    |             |           |          |          |  __774.99__ | __65.28__  | 653.50   | 897.88   |
| height             | __1879.72__ | __37.71__ | 1809.30  | 1950.64  +-------------+------------+----------+----------+
|                    |             |           |          |          |  __1762.66__| __64.04__  | 1639.62  | 1881.66  |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    |             |           |          |          |  0.16       | 0.02       | 0.13     | 0.20     |
| std                | 0.53        | 0.02      | 0.48     | 0.56     +-------------+------------+----------+----------+
|                    |             |           |          |          |  0.15       | 0.01       | 0.14     | 0.17     |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
|                    |             |           |          |          |  6.56       | 0.72       | 5.22     | 7.88     |
| sn                 | 18.24       | 1.37      | 15.69    | 20.76    +-------------+------------+----------+----------+
|                    |             |           |          |          |  14.93      | 1.14       | 12.82    | 17.14    |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+
| alpha              | 2.96        | 0.39      | 2.27     | 3.71     |  -          | -          | -        | -        |
+--------------------+-------------+-----------+----------+----------+-------------+------------+----------+----------+

grafik

I reverted to embedding Table 2 from the SVG...

@michaelosthege michaelosthege force-pushed the peak-performance-paper branch from e6e592f to 70e5470 Compare August 20, 2024 14:46
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@michaelosthege
Copy link
Member

michaelosthege commented Oct 12, 2024

Documentation build ❌ because Sphinx released 8.1.0 which broke sphinxcontrib.mermaid 0.9.2 (mermaid-js/mermaid#5954).
The sphinxcontrib.mermaid 1.0.0 release is almost there (mgaitan/sphinxcontrib-mermaid#153) and will fix this, so let's just wait.

Copy link
Member

@michaelosthege michaelosthege left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed to merge this and continue refactoring the paper/documentation on main.

@Y0dler Y0dler merged commit a833893 into main Oct 13, 2024
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 13, 2024
@Y0dler Y0dler deleted the peak-performance-paper branch October 13, 2024 13:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants