search

cog-imperial / OMLT

Represent trained machine learning models as Pyomo optimization formulations
Other
271 stars 57 forks source link

add comments for math formulations #65

Closed ThebTron closed 2 years ago

ThebTron commented 2 years ago

I added comments and math formulations for all functions used to generate the gradient-boosted trees optimization model. Is there an easy way to test how these comments will look like in the docs before merging?

codecov[bot] commented 2 years ago

Codecov Report

Merging #65 (444df10) into main (392ed45) will increase coverage by 0.06%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #65      +/-   ##
==========================================
+ Coverage   94.12%   94.18%   +0.06%     
==========================================
  Files          24       24              
  Lines        1242     1239       -3     
  Branches      192      192              
==========================================
- Hits         1169     1167       -2     
+ Misses         43       42       -1     
  Partials       30       30
Impacted Files Coverage Δ
src/omlt/gbt/__init__.py 100.00% <ø> (ø)
src/omlt/gbt/gbt_formulation.py 93.60% <ø> (ø)
src/omlt/gbt/model.py 97.61% <ø> (+2.06%) :arrow_up:

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...444df10. Read the comment docs.

michaelbynum commented 2 years ago

You should be able to run make html from the docs directory to build the docs locally, which you can then view with a browser.

jalving commented 2 years ago

These doc strings look great. Go ahead and merge if you are done working on them.