search

cog-imperial / OMLT

Represent trained machine learning models as Pyomo optimization formulations
Other
257 stars 56 forks source link

add some doc strings to neural network functions #64

Closed tsaycal closed 2 years ago

codecov[bot] commented 2 years ago

Codecov Report

Merging #64 (9cad2f1) into main (392ed45) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #64   +/-   ##
=======================================
  Coverage   94.12%   94.12%           
=======================================
  Files          24       24           
  Lines        1242     1242           
  Branches      192      192           
=======================================
  Hits         1169     1169           
  Misses         43       43           
  Partials       30       30
Impacted Files Coverage Δ
src/omlt/neuralnet/activations/relu.py 96.77% <ø> (ø)
src/omlt/neuralnet/activations/smooth.py 100.00% <ø> (ø)
src/omlt/neuralnet/layer.py 90.57% <ø> (ø)
src/omlt/neuralnet/layers/full_space.py 100.00% <ø> (ø)
src/omlt/neuralnet/layers/partition_based.py 94.02% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 392ed45...9cad2f1. Read the comment docs.

jalving commented 2 years ago

I notice doc strings with LaTeX need to be raw strings (e.g. r"\alpha") or use double backslashes. I fixed the typo in the readme too.

rmisener commented 2 years ago

Thanks, @tsaycal and @jalving! This is looking great.