wilson-labs / cola

Compositional Linear Algebra
Apache License 2.0
401 stars 26 forks source link

Added all the ingredients to enforce high quality code #60

Closed AndPotap closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 46.15% and project coverage change: -0.18% :warning:

Comparison is base (ea41fbf) 78.62% compared to head (deb1874) 78.44%.

:exclamation: Current head deb1874 differs from pull request most recent head 812a106. Consider uploading reports for the commit 812a106 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #60 +/- ## ========================================== - Coverage 78.62% 78.44% -0.18% ========================================== Files 36 36 Lines 2975 2974 -1 ========================================== - Hits 2339 2333 -6 - Misses 636 641 +5 ``` | [Files Changed](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs) | Coverage Δ | | |---|---|---| | [cola/\_\_init\_\_.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9fX2luaXRfXy5weQ==) | `100.00% <ø> (ø)` | | | [cola/algorithms/arnoldi.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9hbGdvcml0aG1zL2Fybm9sZGkucHk=) | `94.48% <ø> (-0.05%)` | :arrow_down: | | [cola/algorithms/diagonal\_estimation.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9hbGdvcml0aG1zL2RpYWdvbmFsX2VzdGltYXRpb24ucHk=) | `76.13% <ø> (-0.27%)` | :arrow_down: | | [cola/algorithms/lanczos.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9hbGdvcml0aG1zL2xhbmN6b3MucHk=) | `85.09% <ø> (-0.10%)` | :arrow_down: | | [cola/algorithms/svrg.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9hbGdvcml0aG1zL3N2cmcucHk=) | `9.75% <0.00%> (-0.06%)` | :arrow_down: | | [cola/fns.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9mbnMucHk=) | `80.91% <ø> (ø)` | | | [cola/linalg/nullspace.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9saW5hbGcvbnVsbHNwYWNlLnB5) | `24.63% <0.00%> (-0.74%)` | :arrow_down: | | [cola/linalg/svd.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9saW5hbGcvc3ZkLnB5) | `41.66% <ø> (ø)` | | | [cola/ops/operator\_base.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9vcHMvb3BlcmF0b3JfYmFzZS5weQ==) | `74.69% <ø> (ø)` | | | [cola/ops/operators.py](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs#diff-Y29sYS9vcHMvb3BlcmF0b3JzLnB5) | `85.94% <ø> (ø)` | | | ... and [7 more](https://app.codecov.io/gh/wilson-labs/cola/pull/60?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=wilson-labs) | |

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

mfinzi commented 1 year ago

Can you explain what it does?

AndPotap commented 1 year ago

@mfinzi , I'm in the process of fixing all the code. I'll explain once I'm done

AndPotap commented 1 year ago

@mfinzi Basically. (1) I added a bash file to add a pre-commit hook for each user so that the formatters are run when they make a commit. (2) Created a Github action that checks both that all the files follow the format and that it follows PEP8 (via flake8). (3) Run the formater on all the files in the repo. (4) Fixed all the errors highlighted by flake8: unsued imports, multiple imports, unsued variables, trailing white spaces, undefined variables, etc.

AndPotap commented 1 year ago

@mfinzi could you accept it to give it a try :upside_down_face: