Feature metric jsd (#66)

[MooooCat]

• [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

• Apply suggestions from code review

• jsd

• jsd

• [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

• base更新

• [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

• Delete .idea directory

---

Description

The JSD single column metric.

Motivation and Context

Since the base class of metric(Branch: feature-metric-base) has not yet been merged into the main branch, this JSD branch will first merge into the feature metric base and then merge into the main branch.

Due to changes in some components, it is necessary to make some modifications to the examples before merging.

Types of changes

• Maintenance (no change in code, maintain the project's CI, docs, etc.)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[sweep-ai]

Apply Sweep Rules to your PR?

• Apply: All new business logic should have corresponding unit tests.
• Apply: Refactor large functions to be more modular.
• Apply: Add docstrings to all functions and file headers.

[Wh1isper]

Suggest add some type hint here

[MooooCat]

Thanks to @Wh1isper for the carefully review. I will add some descriptive comments for input parameters in the method calculate.

[Wh1isper]

Actually type hint and docstring are all we need

Like we did in https://github.com/hitsz-ids/synthetic-data-generator/blob/main/sdgx/data_processors/base.py

Example:

# type hint example

# For python 3.8 and 3.9
from __future__ import annotations

@classmethod
def calculate(cls, real_data: pd.DataFrame, synthetic_data: pd.DataFrame, discrete: list[str] | None, cols: list[str] | None) -> pd.DataFrame:
"""
What is this function

Args:
  real_data (pd.DataFrame): balabala...
  ....

"""

[Wh1isper]

Actually type hint and docstring are all we need

Like we did in main/sdgx/data_processors/base.py

Example:

# type hint example

# For python 3.8 and 3.9
from __future__ import annotations 

@classmethod
def calculate(cls, real_data: pd.DataFrame, synthetic_data: pd.DataFrame, discrete: list[str] | None, cols: list[str] | None) -> pd.DataFrame:
"""
What is this function

Args:
  real_data (pd.DataFrame): balabala...
  ....

"""

I'd be inclined to add this to all public methods, especially those that require subclass implementation. This is very intuitive for developers and users, and allows static checking tools to work well.

[Wh1isper]

LGTM. Thanks!