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.

Sign up for GitHub

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

Jump to bottom

Add scaling figure and section explaining scaling in README #17

Merged
merged 8 commits into from
Aug 4, 2021
Merged

Add scaling figure and section explaining scaling in README #17

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5ca8562
Add scaling figure and section explaining scaling in README
ulupo Aug 3, 2021
df50095
Try centering speedup image
ulupo Aug 4, 2021
9357f0b
Try centering with raw html
ulupo Aug 4, 2021
66d3717
Fix typo and try relative paths
ulupo Aug 4, 2021
6775986
Try one last raw html approach
ulupo Aug 4, 2021
fb2fa4c
Revert to standard RST directives
ulupo Aug 4, 2021
71017b3
Remove alt text
ulupo Aug 4, 2021
859a522
Place global URL instead of relative path
ulupo Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ License
``giotto-ph`` is distributed under the AGPLv3 `license <https://github.com/giotto-ai/giotto-tda/blob/master/LICENSE>`_.
If you need a different distribution license, please contact the `L2F team`_.

Parallel persistent homology backend
====================================

Computing persistence barcodes of large datasets and in high homology degrees is challenging even on modern hardware. ``giotto-ph``'s persistent homology backend
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
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Collaborator Author

@ulupo ulupo Aug 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@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?)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh ! I was not aware, good to know !

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done. Ready as far as I am concerned. Let me know :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

You can merge

MonkeyBreaker marked this conversation as resolved.
Show resolved Hide resolved
MonkeyBreaker marked this conversation as resolved.
Show resolved Hide resolved
:width: 500

Basic usage in Python
=====================

Expand Down Expand Up @@ -111,7 +121,6 @@ Use the ``weights`` and ``weight_params`` parameters to constructed a weighted R

dgm_dtm = ripser_parallel(pc, weights="DTM", n_threads=-1)



Documentation and Tutorials
===========================
Expand Down
Loading