Skip to content

Change scores MLI and MEI to LI and EI#233

Merged
bfolie merged 2 commits intodevelopfrom
remove-max-from-scores
Feb 25, 2020
Merged

Change scores MLI and MEI to LI and EI#233
bfolie merged 2 commits intodevelopfrom
remove-max-from-scores

Conversation

@bfolie
Copy link
Copy Markdown

@bfolie bfolie commented Feb 25, 2020

Citrine Python PR

Description

The Scores "MLI" and "MEI" are actually scoring the likelihood of improvement and expected improvement. The addition of "Maximum" is a misnomer.

Note this change is non-breaking with respect to the API and doesn't require modifying backend code. The backend code can continue to refer to these objects as "MLI" and "MEI."

PR Type:

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.

Copy link
Copy Markdown
Contributor

@maxhutch maxhutch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

return {
'MLI': MLIScore,
'MEI': MEIScore
'MLI': LIScore,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this makes the change non-breaking wrt the API.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a comment to that affect in the PR description, because I think that's the most important thing for @andyczerwonka . This user-facing change does not compel the backend code or the API to change.

@bfolie bfolie merged commit da934d3 into develop Feb 25, 2020
@Imperssonator
Copy link
Copy Markdown
Contributor

Looks VERY good to me XD

@bfolie bfolie deleted the remove-max-from-scores branch October 2, 2020 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants