pyt-team / TopoModelX

Topological Deep Learning
https://pyt-team.github.io/topomodelx/
MIT License
234 stars 82 forks source link

Add typing annotations throughout the project #178

Closed ffl096 closed 1 year ago

ffl096 commented 1 year ago

These have been automatically generated by autotyping and are by no means perfect. For example at certain places more specific Literal types instead of str could be used. This is, however, already a huge step in the right direction.

Along the way, this also fixed some documentation errors or moved to a more consistent documentation style.

See #174

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (ff0425a) 97.74% compared to head (c7dde37) 97.74%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #178 +/- ## ======================================= Coverage 97.74% 97.74% ======================================= Files 33 33 Lines 1508 1508 ======================================= Hits 1474 1474 Misses 34 34 ``` | [Files Changed](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team) | Coverage Δ | | |---|---|---| | [topomodelx/base/conv.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9iYXNlL2NvbnYucHk=) | `100.00% <ø> (ø)` | | | [topomodelx/nn/hypergraph/hnhn\_layer\_bis.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9oeXBlcmdyYXBoL2huaG5fbGF5ZXJfYmlzLnB5) | `100.00% <ø> (ø)` | | | [topomodelx/nn/hypergraph/unigin\_layer.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9oeXBlcmdyYXBoL3VuaWdpbl9sYXllci5weQ==) | `93.33% <ø> (ø)` | | | [topomodelx/base/aggregation.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9iYXNlL2FnZ3JlZ2F0aW9uLnB5) | `100.00% <100.00%> (ø)` | | | [topomodelx/base/message\_passing.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9iYXNlL21lc3NhZ2VfcGFzc2luZy5weQ==) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/cell/can\_layer.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9jZWxsL2Nhbl9sYXllci5weQ==) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/cell/can\_layer\_bis.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9jZWxsL2Nhbl9sYXllcl9iaXMucHk=) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/cell/ccxn\_layer.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9jZWxsL2NjeG5fbGF5ZXIucHk=) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/cell/cwn\_layer.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9jZWxsL2N3bl9sYXllci5weQ==) | `100.00% <100.00%> (ø)` | | | [topomodelx/nn/hypergraph/allset\_layer.py](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team#diff-dG9wb21vZGVseC9ubi9oeXBlcmdyYXBoL2FsbHNldF9sYXllci5weQ==) | `91.52% <100.00%> (ø)` | | | ... and [22 more](https://app.codecov.io/gh/pyt-team/TopoModelX/pull/178?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pyt-team) | |

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