Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make EmitterBase easier to extend #101

Merged
merged 12 commits into from Mar 11, 2021
Merged

Make EmitterBase easier to extend #101

merged 12 commits into from Mar 11, 2021

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Mar 11, 2021

Description

A clean-up of EmitterBase and its children to make it as easy as possible to extend.

Resolves #98

Changelog Description

TODO

  • Remove "children-only" / "protected" variables
    • Remove the _rng attribute and put it in the children, as not all emitters may need it
    • Make _archive a public attribute
  • Remove the seed parameter (without _rng, there is no need for seed)
  • Check that existing emitters are not accessing private attributes such as _lower_bounds and _upper_bounds
  • solution_dim and bounds should be okay to keep
  • remove batch_size
  • make Optimizer keep track of the number of solutions generated
  • The default tell() makes sense, but its docstring should be updated to be more clear on what it does
  • Fix all existing emitters to use the new API
  • Fix tests to not depend on old API

Questions

Status

  • I have read the guidelines in
    CONTRIBUTING.md.
  • I have formatted my code using yapf
  • I have tested my code by running pytest (tox is run in CI/CD)
  • I have linted my code with pylint
  • This PR is ready to go

@btjanaka btjanaka changed the title Make EmitterBase easy to extend Make EmitterBase easier to extend Mar 11, 2021
@btjanaka btjanaka merged commit 0b10295 into master Mar 11, 2021
@btjanaka btjanaka deleted the emitter branch March 11, 2021 10:09
@btjanaka btjanaka added this to the v0.4.0 milestone Jul 7, 2021
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.

[FEATURE REQUEST] Make emitters easy to extend
1 participant