pyt-team / TopoModelX

Topological Deep Learning
MIT License
222 stars 79 forks source link

Fixing Issues with thumbnails and API Reference Docs #177

Closed devendragovil closed 1 year ago

devendragovil commented 1 year ago

Fixing thumbnail issue #169

Also making progress in resolving #165 API Reference display

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.01% :tada:

Comparison is base (ff0425a) 97.74% compared to head (76a6921) 97.76%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #177 +/- ## ========================================== + Coverage 97.74% 97.76% +0.01% ========================================== Files 33 35 +2 Lines 1508 1518 +10 ========================================== + Hits 1474 1484 +10 Misses 34 34 ``` | [Files Changed](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/177?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team) | Coverage Δ | | |---|---|---| | [topomodelx/\_\_init\_\_.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/177?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9fX2luaXRfXy5weQ==) | `100.00% <100.00%> (ø)` | | | [topomodelx/base/\_\_init\_\_.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/177?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9iYXNlL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/\_\_init\_\_.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/177?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9fX2luaXRfXy5weQ==) | `100.00% <100.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ninamiolane commented 1 year ago

Awesome, thanks for this! For the thumbnails, it might be better to use the tensor diagrams of the NNs, such as the one from the screenshot, instead of the message passing equations (that you currently have in the .png). What do you think?

  1. I'm scared that the equations would not look as good as thumbnails.
  2. We already have the equations in the docstrings of the methods.
Screen Shot 2023-08-29 at 3 00 13 PM

Tensor diagrams can be found here: https://arxiv.org/pdf/2304.10031.pdf

devendragovil commented 1 year ago

I heartily agree, I just wanted to have something to test if the code works. I will update the images by EOD with the diagrams.

ninamiolane commented 1 year ago

Awesome, thanks for the quick answer! I can share the .svg or the .pdf of the figure with the tensor diagrams via email, if you want to be able to screenshot the diagrams easily.

devendragovil commented 1 year ago

Oh yeah, that would be awesome. You can mail me at govildev@gmail.com. Thanks a lot!

ninamiolane commented 1 year ago

@devendragovil I'm converting to drafty for now, I'll let you mark it ready for review when you'd like a review. Thanks for everything!