Add base class for metrics in metrics/base.py #5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a base class for metrics in the
metrics/base.py
file. The base class,BaseMetric
, provides a foundation for implementing various metrics that can evaluate the similarity between synthetic and real datasets.Summary
pass
statement from themetrics/base.py
file.ABC
andabstractmethod
from theabc
module.BaseMetric
that inherits fromABC
.__init__
method in theBaseMetric
class to store thereal_data
andsynthetic_data
as instance variables.calculate
in theBaseMetric
class to calculate the metric. This method will be implemented in each subclass.validate_datasets
in theBaseMetric
class to validate the input datasets. Currently, this method does not perform any validation.Please review and merge this PR. Thank you!
Fixes #3.
To checkout this PR branch, run the following command in your terminal:
To get Sweep to edit this pull request, leave a comment below or in the code. Leaving a comment in the code will only modify the file but commenting below can change the entire PR.