search

cog-imperial / OMLT

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

Setup Documentation #57

Closed jalving closed 2 years ago

jalving commented 2 years ago

This PR will add documentation built with Sphinx and hosted on readthedocs.

See the test build here: https://omlt.readthedocs.io/en/documentation/

Once the docs build after merging, the doc badge should redirect to the up-to-date documentation.

codecov[bot] commented 2 years ago

Codecov Report

Merging #57 (83f1ee2) into main (683caa7) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #57   +/-   ##
=======================================
  Coverage   94.15%   94.15%           
=======================================
  Files          24       24           
  Lines        1231     1231           
  Branches      186      186           
=======================================
  Hits         1159     1159           
  Misses         42       42           
  Partials       30       30
Impacted Files Coverage Δ
src/omlt/formulation.py 92.53% <ø> (ø)
src/omlt/io/keras_reader.py 89.47% <ø> (ø)
src/omlt/io/onnx.py 85.71% <ø> (ø)
src/omlt/neuralnet/__init__.py 100.00% <ø> (ø)
src/omlt/neuralnet/activations/linear.py 100.00% <ø> (ø)
src/omlt/neuralnet/activations/smooth.py 100.00% <ø> (ø)
src/omlt/neuralnet/layers/full_space.py 100.00% <ø> (ø)
src/omlt/neuralnet/layers/reduced_space.py 100.00% <ø> (ø)
src/omlt/block.py 100.00% <100.00%> (ø)
src/omlt/scaling.py 100.00% <100.00%> (ø)

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 683caa7...83f1ee2. Read the comment docs.