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

Create BaseSynthesizer class #1012

Closed
amontanez24 opened this issue Sep 16, 2022 · 0 comments · Fixed by #1023
Closed

Create BaseSynthesizer class #1012

amontanez24 opened this issue Sep 16, 2022 · 0 comments · Fixed by #1023
Assignees
Labels
feature request Request for a new feature
Milestone

Comments

@amontanez24
Copy link
Contributor

amontanez24 commented Sep 16, 2022

Problem Description

As a user, it would be helpful if the naming of everything in SDV was consistent and clear.

We want to rename all of the current models to synthesizers. This is the first issue in that process.

Expected behavior

  • Create a single_table module in sdv
  • In this module create a BaseSynthesizer class
  • Add an __init__ to this class that sets all of the required attributes for all synthesizers. These include:
    • metadata (SingleTableMetadata)
    • enforce_min_max_values (bool)
    • enforce_rounding (bool)
  • Add a get_metadata() method
    • This returns the SingleTableMetadata object
  • Add a get_parameters method
    • This returns a dictionary of the parameters in the synthesizer minus the metadata. eg.
model.get_parameters()
{
  'enforce_min_max_values': True,
  'enforce_rounding': False,
  'numerical_column_distributions': {
    'age': 'beta',
    'height': 'gaussian'
  }
}

Additional context

  • We may want to create the DataProcessor in the init as well, although that will be a private attribute
@amontanez24 amontanez24 added the feature request Request for a new feature label Sep 16, 2022
@amontanez24 amontanez24 added this to the 1.0.0 milestone Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants