Add scaling figure and section explaining scaling in README #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ulupo
commented
Aug 3, 2021
README.rst
Outdated
| is able to distribute the key stages of the computation (namely, search for apparent pairs and coboundary matrix reduction) across an arbitrary number of available CPU threads. | ||
| The scaling is generally quite favourable as shown in the following figure (for more details, see our paper linked below): | ||
|
|
||
| .. image:: https://raw.githubusercontent.com/giotto-ai/giotto-ph/readme_speedup_figure/docs/images/multithreading_speedup.svg |
There was a problem hiding this comment.
Suggested change
| .. image:: https://raw.githubusercontent.com/giotto-ai/giotto-ph/readme_speedup_figure/docs/images/multithreading_speedup.svg | |
| .. image:: https://raw.githubusercontent.com/giotto-ai/giotto-ph/main/docs/images/multithreading_speedup.svg |
To be changed after review
There was a problem hiding this comment.
@MonkeyBreaker FYI, the reason for not using relative paths is that, when we were doing this in giotto-tda, the image was not rendered in the PyPI readme (I think this is because we are excluding the docs folder from the package?)
There was a problem hiding this comment.
Oh ! I was not aware, good to know !
There was a problem hiding this comment.
Done. Ready as far as I am concerned. Let me know :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.